Method: zoneOperations.list

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

HTTP request

GET https://compute.googleapis.com/compute/v1/projects/{project}/zones/{zone}/operations

The URL uses Google API HTTP annotation syntax.

Path parameters

Parameters
project

string

Project ID for this request.

zone

string

Name of the zone for request.

Query parameters

Parameters
maxResults

number (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

Sets a filter {expression} for filtering listed resources. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

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.

Request body

The request body must be empty.

Response body

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

Contains a list of Operation resources.

JSON representation
{
  "id": string,
  "items": [
    {
      "id": string,
      "creationTimestamp": string,
      "name": string,
      "zone": string,
      "clientOperationId": string,
      "operationType": string,
      "targetLink": string,
      "targetId": string,
      "status": enum,
      "statusMessage": string,
      "user": string,
      "progress": number,
      "insertTime": string,
      "startTime": string,
      "endTime": string,
      "error": {
        "errors": [
          {
            "code": string,
            "location": string,
            "message": string
          }
        ]
      },
      "warnings": {
        "code": enum,
        "message": string,
        "data": [
          {
            "key": string,
            "value": string
          }
        ]
      },
      "httpErrorStatusCode": number,
      "httpErrorMessage": string,
      "selfLink": string,
      "region": string,
      "description": string,
      "kind": string
    }
  ],
  "nextPageToken": string,
  "selfLink": string,
  "warning": {
    "code": enum,
    "message": string,
    "data": {
      "key": string,
      "value": string
    }
  },
  "kind": string,
}
Fields
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[].id

string (fixed64 format)

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

items[].creationTimestamp

string

[Deprecated] This field is deprecated.

items[].name

string

[Output Only] Name of the resource.

items[].zone

string

[Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

items[].clientOperationId

string

[Output Only] Reserved for future use.

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 persistent disk that the snapshot was created from.

items[].targetId

string (fixed64 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.

items[].progress

number

[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[].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

number

[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 available when performing regional operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

items[].description

string

[Output Only] A textual description of the operation, which is set when the operation is created.

items[].kind

string

[Output Only] Type of the resource. Always compute#operation for Operation resources.

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.

kind

string

[Output Only] Type of resource. Always compute#operations for Operations resource.

Authorization Scopes

Requires one of the following OAuth scopes:

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

For more information, see the Auth Guide.

IAM Permissions

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

  • compute.zoneOperations.list

Send feedback about...

Compute Engine