Please note that the contents of this offline web site may be out of date. To access the most recent documentation visit the online version .
Note that links that point to online resources are green in color and will open in a new window.
We would love it if you could give us feedback about this material by filling this form (You have to be online to fill it)



GlobalOperations: aggregatedList

Requires authorization

Retrieves the list of all operations grouped by scope. Try it now .

Request

HTTP request 

GET https://www.googleapis.com/compute/v1/projects/project/aggregated/operations

Parameters

Parameter name Value Description
Path parameters
project string Project ID of the project scoping this request.
Optional query parameters
filter string Filter expression for filtering listed resources, in the form filter={expression} . Your {expression} must contain the following: 
<field_name> <comparison_string> <literal_string>
  • <field_name> : The name of the field you want to compare. The field name must be valid for the type of resource being filtered. Only atomic field types are supported (string, number, boolean). Array and object fields are not currently supported.
  • <comparison_string> : The comparison string, either eq (equals) or ne (not equals).
  • <literal_string> : The literal string value to filter to. The literal value must be valid for the type of field (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, when filtering instances, name eq my_instance won't work, but name eq .*my_instance will work.

For example: 

filter=status ne RUNNING

The above filter returns only results whose status field does not equal RUNNING . You can also enclose your literal string in single, double, or no quotes. For example, all three of the following would be valid expressions: 

filter=status ne "RUNNING"
filter=status ne 'RUNNING'
filter=status ne RUNNING

If you use a complex regular expression, you need to encode the special characters, including quotes. Consider the following regular expression: 

name eq '.*/my_instance_[0-9]+'

To use the expression, you would need to encode it: 

filter=name%20eq%20%27.%2A%2Fmy_instance_%5B0-9%5D%2B%27&
maxResults unsigned integer Maximum count of results to be returned. Maximum and default value is 100 . Acceptable values are 0 to 500 , inclusive. (Default: 100 )
pageToken string Specifies a nextPageToken returned by a previous list request. This token can be used to request the next page of results from a previous list request.

Authorization

This request requires authorization with at least one of the following scopes ( read more about authentication and authorization ).

Scope
https://www.googleapis.com/auth/compute.readonly
https://www.googleapis.com/auth/compute

Request body

Do not supply a request body with this method.

Response

If successful, this method returns a response body with the following structure: 

{
  "kind": "compute#operationAggregatedList",
  "id": string,
  "items": {
    (key): {
      "operations": [
        {
          "kind": "compute#operation",
          "id": unsigned long,
          "creationTimestamp": string,
          "name": string,
          "zone": string,
          "clientOperationId": string,
          "operationType": string,
          "targetLink": string,
          "targetId": unsigned long,
          "status": string,
          "statusMessage": string,
          "user": string,
          "progress": integer,
          "insertTime": string,
          "startTime": string,
          "endTime": string,
          "error": {
            "errors": [
              {
                "code": string,
                "location": string,
                "message": string
              }
            ]
          },
          "warnings": [
            {
              "code": string,
              "message": string,
              "data": [
                {
                  "key": string,
                  "value": string
                }
              ]
            }
          ],
          "httpErrorStatusCode": integer,
          "httpErrorMessage": string,
          "selfLink": string,
          "region": string
        }
      ],
      "warning": {
        "code": string,
        "message": string,
        "data": [
          {
            "key": string,
            "value": string
          }
        ]
      }
    }
  },
  "nextPageToken": string,
  "selfLink": string
}
Property name Value Description Notes
kind string [Ouput Only] Type of resource. Always compute#diskAggregatedList for an aggregated list of Operation resources.
id string [Output Only] Unique identifier for the resource. This is generated by the server.
items object [Output Only] A map of scoped operation lists.
items. (key) nested object [Output Only] Name of the scope containing this set of operations.
items.(key). operations[] list [Output Only] List of operations contained in this scope.
items.(key). warning object [Output Only] Informational warning which replaces the list of operations when the list is empty.
items.(key).warning. code string [Output Only] The warning type identifier for this warning.

Acceptable values are:
  • " DEPRECATED_RESOURCE_USED ":
  • " INJECTED_KERNELS_DEPRECATED ":
  • " NEXT_HOP_ADDRESS_NOT_ASSIGNED ":
  • " NEXT_HOP_CANNOT_IP_FORWARD ":
  • " NEXT_HOP_INSTANCE_NOT_FOUND ":
  • " NEXT_HOP_INSTANCE_NOT_ON_NETWORK ":
  • " NEXT_HOP_NOT_RUNNING ":
  • " NO_RESULTS_ON_PAGE ":
  • " REQUIRED_TOS_AGREEMENT ":
  • " UNREACHABLE ":
items.(key).warning. message string [Output Only] Optional human-readable details for this warning.
items.(key).warning. data[] list [Output Only] Metadata for this warning in 'key: value' format.
items.(key).warning.data[]. key string [Output Only] A key for the warning data.
items.(key).warning.data[]. value string [Output Only] A warning data value corresponding to the key.
nextPageToken string [Output Only] A token used to continue a truncated list request (output only).
items.(key).operations[]. kind string Type of the resource.
items.(key).operations[]. id unsigned long Unique identifier for the resource; defined by the server (output only).
items.(key).operations[]. creationTimestamp string Creation timestamp in RFC3339 text format (output only).
items.(key).operations[]. name string Name of the resource (output only).
items.(key).operations[]. zone string URL of the zone where the operation resides (output only).
items.(key).operations[]. clientOperationId string An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project (output only).
items.(key).operations[]. operationType string Type of the operation. Examples include "insert", "update", and "delete" (output only).
items.(key).operations[]. targetId unsigned long Unique target id which identifies a particular incarnation of the target (output only).
items.(key).operations[]. status string Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE" (output only).

Acceptable values are:
  • " DONE ":
  • " PENDING ":
  • " RUNNING ":
items.(key).operations[]. statusMessage string An optional textual description of the current status of the operation (output only).
items.(key).operations[]. user string User who requested the operation, for example "[email protected]" (output only).
items.(key).operations[]. progress integer 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 at when the operation will be complete. This number should be monotonically increasing as the operation progresses (output only).
items.(key).operations[]. insertTime string The time that this operation was requested. This is in RFC 3339 format (output only).
items.(key).operations[]. startTime string The time that this operation was started by the server. This is in RFC 3339 format (output only).
items.(key).operations[]. endTime string The time that this operation was completed. This is in RFC 3339 format (output only).
items.(key).operations[]. error object If errors occurred during processing of this operation, this field will be populated (output only).
items.(key).operations[].error. errors[] list The array of errors encountered while processing this operation.
items.(key).operations[].error.errors[]. code string The error type identifier for this error.
items.(key).operations[].error.errors[]. location string Indicates the field in the request which caused the error. This property is optional.
items.(key).operations[].error.errors[]. message string An optional, human-readable error message.
items.(key).operations[]. warnings[] list If warning messages generated during processing of this operation, this field will be populated (output only).
items.(key).operations[].warnings[]. code string The warning type identifier for this warning.

Acceptable values are:
  • " DEPRECATED_RESOURCE_USED ":
  • " INJECTED_KERNELS_DEPRECATED ":
  • " NEXT_HOP_ADDRESS_NOT_ASSIGNED ":
  • " NEXT_HOP_CANNOT_IP_FORWARD ":
  • " NEXT_HOP_INSTANCE_NOT_FOUND ":
  • " NEXT_HOP_INSTANCE_NOT_ON_NETWORK ":
  • " NEXT_HOP_NOT_RUNNING ":
  • " NO_RESULTS_ON_PAGE ":
  • " REQUIRED_TOS_AGREEMENT ":
  • " UNREACHABLE ":
items.(key).operations[].warnings[]. message string Optional human-readable details for this warning.
items.(key).operations[].warnings[]. data[] list Metadata for this warning in 'key: value' format.
items.(key).operations[].warnings[].data[]. key string A key for the warning data.
items.(key).operations[].warnings[].data[]. value string A warning data value corresponding to the key.
items.(key).operations[]. httpErrorStatusCode integer If operation fails, the HTTP error status code returned, e.g. 404. (output only).
items.(key).operations[]. httpErrorMessage string If operation fails, the HTTP error message returned, e.g. NOT FOUND. (output only).
items.(key).operations[]. region string URL of the region where the operation resides (output only).

Try it!

Use the APIs Explorer below to call this method on live data and see the response.

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 3.0 License , and code samples are licensed under the Apache 2.0 License . For details, see our Site Policies .

Authentication required

You need to be signed in with Google+ to do that.

Signing you in...

Google Developers needs your permission to do that.