Method: globalVmExtensionPolicies.list

Lists global VM extension policies.

HTTP request

GET https://compute.googleapis.com/compute/beta/projects/{project}/global/vmExtensionPolicies

The URL uses gRPC Transcoding syntax. To know more about valid error responses that can be thrown by this HTTP request, please refer to the service error catalog

Path parameters

Parameters
project

string

Project ID for this request.

Query parameters

Parameters
maxResults

integer (uint32 format)

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)
pageToken

string

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
filter

string

A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request.

If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either =, !=, >, <, <=, >= or :.

For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.

The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use:

labels.owner:*

You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.

To filter on multiple expressions, provide each separate expression within parentheses. For example:

(scheduling.automaticRestart = true)
(cpuPlatform = "Intel Skylake")

By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example:

(cpuPlatform = "Intel Skylake") OR
(cpuPlatform = "Intel Broadwell") AND
(scheduling.automaticRestart = true)

If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples:

fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal")

The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field.

For example, to filter for instances that do not end with name "instance", you would use name ne .*instance.

You cannot combine constraints on multiple fields using regular expressions.
orderBy

string

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
returnPartialSuccess

boolean

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.

For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

Request body

The request body must be empty.

Response body

Response to list global VM extension policy resources.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "kind": string,
  "id": string,
  "items": [
    {
      "kind": string,
      "id": string,
      "creationTimestamp": string,
      "updateTimestamp": string,
      "name": string,
      "description": string,
      "selfLink": string,
      "selfLinkWithId": string,
      "extensionPolicies": {
        string: {
          "stringConfig": string,
          "pinnedVersion": string
        },
        ...
      },
      "instanceSelectors": [
        {

          // Union field selector_type can be only one of the following:
          "labelSelector": {
            "inclusionLabels": {
              string: string,
              ...
            }
          }
          // End of list of possible types for union field selector_type.
        }
      ],
      "priority": integer,
      "scopedResourceStatus": enum,
      "rolloutOperation": {
        "rolloutInput": {
          "name": string,
          "predefinedRolloutPlan": enum,
          "retryUuid": string,
          "conflictBehavior": string
        },
        "rolloutStatus": {
          "currentRollouts": [
            {
              "rollout": string,
              "rolloutPlan": string,
              "state": enum
            }
          ],
          "previousRollout": {
            "rollout": string,
            "rolloutPlan": string,
            "state": enum
          }
        }
      }
    }
  ],
  "nextPageToken": string,
  "selfLink": string,
  "warning": {
    "code": enum,
    "message": string,
    "data": [
      {
        "key": string,
        "value": string
      }
    ]
  },
  "etag": string,
  "unreachables": [
    string
  ]
}
Fields
kind

string

Type of resource.
id

string

[Output Only] Unique identifier for the resource; defined by the server.
items[]

object

A list of GlobalVmExtensionPolicy resources.
items[].kind

string

[Output Only] Type of the resource. Always compute#globalVmExtensionPolicy for globalVmExtensionPolicies.
items[].id

string (uint64 format)

[Output Only] The unique identifier for the resource. This identifier is defined by the server.
items[].creationTimestamp

string

[Output Only] Creation timestamp in RFC3339 text format.
items[].updateTimestamp

string

[Output Only] globalVmExtensionPolicies.update timestamp in RFC3339 text format.
items[].name

string

Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
items[].description

string

An optional description of this resource. Provide this property when you create the resource.
items[].selfLink

string

[Output Only] Server-defined fully-qualified URL for this resource.
items[].selfLinkWithId

string

[Output Only] Server-defined URL for this resource's resource id.
items[].extensionPolicies[]

map (key: string, value: object)

Required. Map from extension (eg: "cloudops") to its policy configuration. The key is the name of the extension.
items[].extensionPolicies[].stringConfig

string

Optional. String configuration. Any string payload that the extension understands.
items[].extensionPolicies[].pinnedVersion

string

Optional. The version pinning for the extension. If empty, the extension will be installed with the latest version released by the extension producer.
items[].instanceSelectors[]

object

Optional. Selector to target VMs for a policy. There is a logical "AND" between instanceSelectors.
items[].instanceSelectors[].labelSelector

object

Optional. Labels within the LabelSelector are OR'd.
items[].instanceSelectors[].labelSelector.inclusionLabels

map (key: string, value: string)

Optional. Labels as key value pairs. A VM should contain all the pairs specified in this map to be selected; Labels within the LabelSelector are OR'ed.
items[].priority

integer

Optional. Used to resolve conflicts when multiple policies are active for the same extension. Defaults to 0.

Larger the number, higher the priority. When the priority is the same, the policy with the newer create time has higher priority.
items[].scopedResourceStatus

enum

[Output Only] The scoped resource status. It's only for tracking the purging status of the policy.
items[].rolloutOperation

object

Required. The rollout strategy and status.
items[].rolloutOperation.rolloutInput

object

Required. The rollout input which defines the rollout plan.
items[].rolloutOperation.rolloutInput.name

string

Optional. The name of the rollout plan. Ex. projects//locations/global/rolloutPlans/.
items[].rolloutOperation.rolloutInput.predefinedRolloutPlan

enum

Optional. Predefined rollout plan.
items[].rolloutOperation.rolloutInput.retryUuid

string

Optional. The UUID of the retry action. Only set it if this is a retry for an existing resource. This is for the user re-populate the resource without changes. An error will be returned if the retryUuid is set but the resource get modified.
items[].rolloutOperation.rolloutInput.conflictBehavior

string

Optional. [Optional] Specifies the behavior of the Rollout if a conflict is detected in a project during a Rollout. It can be one of the following values: 1) empty : don't overwrite the local value if conflict happens. This is the default behavior. 2) "overwrite" : Overwrite the local value with the rollout value. The concept of "conflict" applies to: 1) globalVmExtensionPolicies.insert action. If the zonal policy already exists when globalVmExtensionPolicies.insert happens, it's a conflict. 2) globalVmExtensionPolicies.update action. If the zonal policy was updated out of band by a zonal API, it's a conflict.
items[].rolloutOperation.rolloutStatus

object

[Output Only] The rollout status of the policy.
items[].rolloutOperation.rolloutStatus.currentRollouts[]

object

[Output Only] The current rollouts for the latest version of the resource. There should be only one current rollout, but for scalability, we make it repeated.
items[].rolloutOperation.rolloutStatus.currentRollouts[].rollout

string

[Output Only] The name of the rollout. Ex. projects//locations/global/rollouts/.
items[].rolloutOperation.rolloutStatus.currentRollouts[].rolloutPlan

string

[Output Only] The name of the rollout plan. Ex. projects//locations/global/rolloutPlans/.
items[].rolloutOperation.rolloutStatus.currentRollouts[].state

enum

[Output Only] The overall state of the rollout.
items[].rolloutOperation.rolloutStatus.previousRollout

object

[Output Only] The last completed rollout resource. This field will not be populated until the first rollout is completed.
items[].rolloutOperation.rolloutStatus.previousRollout.rollout

string

[Output Only] The name of the rollout. Ex. projects//locations/global/rollouts/.
items[].rolloutOperation.rolloutStatus.previousRollout.rolloutPlan

string

[Output Only] The name of the rollout plan. Ex. projects//locations/global/rolloutPlans/.
items[].rolloutOperation.rolloutStatus.previousRollout.state

enum

[Output Only] The overall state of the rollout.
nextPageToken

string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
warning

object

[Output Only] Informational warning message.
warning.code

enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
warning.message

string

[Output Only] A human-readable description of the warning code.
warning.data[]

object

[Output Only] Metadata about this warning in key: value format. For example: 

"data": [  {  "key": "scope",  "value": "zones/us-east1-d"  }
warning.data[].key

string

[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
warning.data[].value

string

[Output Only] A warning data value corresponding to the key.
etag

string
unreachables[]

string

[Output Only] Unreachable resources.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/compute.readonly
  • https://www.googleapis.com/auth/compute
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

In addition to any permissions specified on the fields above, authorization requires one or more of the following IAM permissions:

  • compute.vmExtensionPolicies.list

To find predefined roles that contain those permissions, see Compute Engine IAM Roles.