Method: regionOperations.list

HTTP request
Path parameters
Query parameters
Request body
Response body
- JSON representation
Authorization scopes
IAM Permissions
Try it!

Retrieves a list of Operation resources contained within the specified region.

HTTP request

GET https://compute.googleapis.com/compute/beta/projects/{project}/regions/{region}/operations

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters

Parameters
`project`	`string` Project ID for this request.
`region`	`string` Name of the region for this request.

project

string

Project ID for this request.

region

string

Name of the region 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

Contains a list of Operation resources.

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

JSON representation

JSON representation
{ "kind": string, "id": string, "items": [ { "setCommonInstanceMetadataOperationMetadata": { "clientOperationId": string, "perLocationOperations": { string: { "state": enum, "error": { "code": integer, "message": string, "details": [ { "@type": string, field1: ..., ... } ] } }, ... } }, "instancesBulkInsertOperationMetadata": { "perLocationStatus": { string: { "status": enum, "targetVmCount": integer, "createdVmCount": integer, "failedToCreateVmCount": integer, "deletedVmCount": integer }, ... } }, "kind": string, "id": string, "creationTimestamp": string, "name": string, "zone": string, "clientOperationId": string, "operationType": string, "targetLink": string, "targetId": string, "status": enum, "statusMessage": string, "user": string, "progress": integer, "insertTime": string, "startTime": string, "endTime": string, "error": { "errors": [ { "code": string, "location": string, "message": string, "errorDetails": [ { // Union field `details_oneof` can be only one of the following: "errorInfo": { "reason": string, "domain": string, "metadatas": { string: string, ... } }, "quotaInfo": { "metricName": string, "limitName": string, "dimensions": { string: string, ... }, "limit": number, "futureLimit": number, "rolloutStatus": enum }, "help": { "links": [ { "description": string, "url": string } ] }, "localizedMessage": { "locale": string, "message": string } // End of list of possible types for union field `details_oneof`. } ] } ] }, "warnings": [ { "code": enum, "message": string, "data": [ { "key": string, "value": string } ] } ], "httpErrorStatusCode": integer, "httpErrorMessage": string, "selfLink": string, "region": string, "description": string, "operationGroupId": string } ], "nextPageToken": string, "selfLink": string, "warning": { "code": enum, "message": string, "data": [ { "key": string, "value": string } ] } }

{
  "kind": string,
  "id": string,
  "items": [
    {
      "setCommonInstanceMetadataOperationMetadata": {
        "clientOperationId": string,
        "perLocationOperations": {
          string: {
            "state": enum,
            "error": {
              "code": integer,
              "message": string,
              "details": [
                {
                  "@type": string,
                  field1: ...,
                  ...
                }
              ]
            }
          },
          ...
        }
      },
      "instancesBulkInsertOperationMetadata": {
        "perLocationStatus": {
          string: {
            "status": enum,
            "targetVmCount": integer,
            "createdVmCount": integer,
            "failedToCreateVmCount": integer,
            "deletedVmCount": integer
          },
          ...
        }
      },
      "kind": string,
      "id": string,
      "creationTimestamp": string,
      "name": string,
      "zone": string,
      "clientOperationId": string,
      "operationType": string,
      "targetLink": string,
      "targetId": string,
      "status": enum,
      "statusMessage": string,
      "user": string,
      "progress": integer,
      "insertTime": string,
      "startTime": string,
      "endTime": string,
      "error": {
        "errors": [
          {
            "code": string,
            "location": string,
            "message": string,
            "errorDetails": [
              {

                // Union field details_oneof can be only one of the following:
                "errorInfo": {
                  "reason": string,
                  "domain": string,
                  "metadatas": {
                    string: string,
                    ...
                  }
                },
                "quotaInfo": {
                  "metricName": string,
                  "limitName": string,
                  "dimensions": {
                    string: string,
                    ...
                  },
                  "limit": number,
                  "futureLimit": number,
                  "rolloutStatus": enum
                },
                "help": {
                  "links": [
                    {
                      "description": string,
                      "url": string
                    }
                  ]
                },
                "localizedMessage": {
                  "locale": string,
                  "message": string
                }
                // End of list of possible types for union field details_oneof.
              }
            ]
          }
        ]
      },
      "warnings": [
        {
          "code": enum,
          "message": string,
          "data": [
            {
              "key": string,
              "value": string
            }
          ]
        }
      ],
      "httpErrorStatusCode": integer,
      "httpErrorMessage": string,
      "selfLink": string,
      "region": string,
      "description": string,
      "operationGroupId": string
    }
  ],
  "nextPageToken": string,
  "selfLink": string,
  "warning": {
    "code": enum,
    "message": string,
    "data": [
      {
        "key": string,
        "value": string
      }
    ]
  }
}

Fields
`kind`	`string` [Output Only] Type of resource. Always `compute#operations` for Operations resource.
`id`	`string` [Output Only] The unique identifier for the resource. This identifier is defined by the server.
`items[]`	`object` [Output Only] A list of Operation resources.
`items[].setCommonInstanceMetadataOperationMetadata`	`object` [Output Only] If the operation is for projects.setCommonInstanceMetadata, this field will contain information on all underlying zonal actions and their state.
`items[].setCommonInstanceMetadataOperationMetadata.clientOperationId`	`string` [Output Only] The client operation id.
`items[].setCommonInstanceMetadataOperationMetadata.perLocationOperations[]`	`map (key: string, value: object)` [Output Only] Status information per location (location name is key). Example key: zones/us-central1-a
`items[].setCommonInstanceMetadataOperationMetadata.perLocationOperations[].state`	`enum` [Output Only] Status of the action, which can be one of the following: `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
`items[].setCommonInstanceMetadataOperationMetadata.perLocationOperations[].error`	`object` [Output Only] If state is `ABANDONED` or `FAILED`, this field is populated.
`items[].setCommonInstanceMetadataOperationMetadata.perLocationOperations[].error.code`	`integer` The status code, which should be an enum value of `google.rpc.Code`.
`items[].setCommonInstanceMetadataOperationMetadata.perLocationOperations[].error.message`	`string` A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the `google.rpc.Status.details` field, or localized by the client.
`items[].setCommonInstanceMetadataOperationMetadata.perLocationOperations[].error.details[]`	`object` A list of messages that carry the error details. There is a common set of message types for APIs to use. An object containing fields of an arbitrary type. An additional field `"@type"` contains a URI identifying the type. Example: `{ "id": 1234, "@type": "types.example.com/standard/id" }`.
`items[].instancesBulkInsertOperationMetadata`	`object`
`items[].instancesBulkInsertOperationMetadata.perLocationStatus[]`	`map (key: string, value: object)` Status information per location (location name is key). Example key: zones/us-central1-a
`items[].instancesBulkInsertOperationMetadata.perLocationStatus[].status`	`enum` [Output Only] Creation status of BulkInsert operation - information if the flow is rolling forward or rolling back.
`items[].instancesBulkInsertOperationMetadata.perLocationStatus[].targetVmCount`	`integer` [Output Only] Count of VMs originally planned to be created.
`items[].instancesBulkInsertOperationMetadata.perLocationStatus[].createdVmCount`	`integer` [Output Only] Count of VMs successfully created so far.
`items[].instancesBulkInsertOperationMetadata.perLocationStatus[].failedToCreateVmCount`	`integer` [Output Only] Count of VMs that started creating but encountered an error.
`items[].instancesBulkInsertOperationMetadata.perLocationStatus[].deletedVmCount`	`integer` [Output Only] Count of VMs that got deleted during rollback.
`items[].kind`	`string` [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
`items[].id`	`string (uint64 format)` [Output Only] The unique identifier for the operation. This identifier is defined by the server.
`items[].creationTimestamp`	`string` [Deprecated] This field is deprecated.
`items[].name`	`string` [Output Only] Name of the operation.
`items[].zone`	`string` [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
`items[].clientOperationId`	`string` [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
`items[].operationType`	`string` [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
`items[].targetLink`	`string` [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the disk that the snapshot was created from.
`items[].targetId`	`string (uint64 format)` [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
`items[].status`	`enum` [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
`items[].statusMessage`	`string` [Output Only] An optional textual description of the current status of the operation.
`items[].user`	`string` [Output Only] User who requested the operation, for example: `user@example.com` or `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
`items[].progress`	`integer` [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
`items[].insertTime`	`string` [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
`items[].startTime`	`string` [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
`items[].endTime`	`string` [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
`items[].error`	`object` [Output Only] If errors are generated during processing of the operation, this field will be populated.
`items[].error.errors[]`	`object` [Output Only] The array of errors encountered while processing this operation.
`items[].error.errors[].code`	`string` [Output Only] The error type identifier for this error.
`items[].error.errors[].location`	`string` [Output Only] Indicates the field in the request that caused the error. This property is optional.
`items[].error.errors[].message`	`string` [Output Only] An optional, human-readable error message.
`items[].error.errors[].errorDetails[]`	`object` [Output Only] An optional list of messages that contain the error details. There is a set of defined message types to use for providing details.The syntax depends on the error code. For example, QuotaExceededInfo will have details when the error code is QUOTA_EXCEEDED.
`items[].error.errors[].errorDetails[].errorInfo`	`object`
`items[].error.errors[].errorDetails[].errorInfo.reason`	`string` The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of `[A-Z][A-Z0-9_]+[A-Z0-9]`, which represents UPPER_SNAKE_CASE.
`items[].error.errors[].errorDetails[].errorInfo.domain`	`string` The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com".
`items[].error.errors[].errorDetails[].errorInfo.metadatas`	`map (key: string, value: string)` Additional structured details about this error. Keys must match /[a-z][a-zA-Z0-9-_]+/ but should ideally be lowerCamelCase. Also they must be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than {"instanceLimit": "100/request"}, should be returned as, {"instanceLimitPerRequest": "100"}, if the client exceeds the number of instances that can be created in a single (batch) request.
`items[].error.errors[].errorDetails[].quotaInfo`	`object`
`items[].error.errors[].errorDetails[].quotaInfo.metricName`	`string` The Compute Engine quota metric name.
`items[].error.errors[].errorDetails[].quotaInfo.limitName`	`string` The name of the quota limit.
`items[].error.errors[].errorDetails[].quotaInfo.dimensions`	`map (key: string, value: string)` The map holding related quota dimensions.
`items[].error.errors[].errorDetails[].quotaInfo.limit`	`number` Current effective quota limit. The limit's unit depends on the quota type or metric.
`items[].error.errors[].errorDetails[].quotaInfo.futureLimit`	`number` Future quota limit being rolled out. The limit's unit depends on the quota type or metric.
`items[].error.errors[].errorDetails[].quotaInfo.rolloutStatus`	`enum` Rollout status of the future quota limit.
`items[].error.errors[].errorDetails[].help`	`object`
`items[].error.errors[].errorDetails[].help.links[]`	`object` URL(s) pointing to additional information on handling the current error.
`items[].error.errors[].errorDetails[].help.links[].description`	`string` Describes what the link offers.
`items[].error.errors[].errorDetails[].help.links[].url`	`string` The URL of the link.
`items[].error.errors[].errorDetails[].localizedMessage`	`object`
`items[].error.errors[].errorDetails[].localizedMessage.locale`	`string` The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX"
`items[].error.errors[].errorDetails[].localizedMessage.message`	`string` The localized error message in the above locale.
`items[].warnings[]`	`object` [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
`items[].warnings[].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.
`items[].warnings[].message`	`string` [Output Only] A human-readable description of the warning code.
`items[].warnings[].data[]`	`object` [Output Only] Metadata about this warning in `key: value` format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }
`items[].warnings[].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).
`items[].warnings[].data[].value`	`string` [Output Only] A warning data value corresponding to the key.
`items[].httpErrorStatusCode`	`integer` [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.
`items[].httpErrorMessage`	`string` [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
`items[].selfLink`	`string` [Output Only] Server-defined URL for the resource.
`items[].region`	`string` [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
`items[].description`	`string` [Output Only] A textual description of the operation, which is set when the operation is created.
`items[].operationGroupId`	`string` [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.
`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.
`selfLink`	`string` [Output Only] Server-defined URL for this resource.
`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.

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.regionOperations.list

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