- HTTP request
- Path parameters
- Query parameters
- Request body
- Response body
- Authorization scopes
- IAM Permissions
- Try it!
Retrieves an aggregated list of all operations.
To prevent failure, Google recommends that you set the returnPartialSuccess
parameter to true
.
HTTP request
GET https://compute.googleapis.com/compute/v1/projects/{project}/aggregated/operations
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
project |
Project ID for this request. |
Query parameters
Parameters | |
---|---|
maxResults |
The maximum number of results per page that should be returned. If the number of available results is larger than |
pageToken |
Specifies a page token to use. Set |
filter |
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 For example, if you are filtering Compute Engine instances, you can exclude instances named The
You can also filter nested fields. For example, you could specify To filter on multiple expressions, provide each separate expression within parentheses. For example:
By default, each expression is an
If you want to use a regular expression, use the
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 You cannot combine constraints on multiple fields using regular expressions. |
orderBy |
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 Currently, only sorting by |
returnPartialSuccess |
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. |
includeAllScopes |
Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. |
serviceProjectNumber |
The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api. |
Request body
The request body must be empty.
Response body
If successful, the response body contains data with the following structure:
JSON representation |
---|
{ "kind": string, "id": string, "items": { string: { "operations": [ { "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": [ { "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 } } ] } ] }, "warnings": [ { "code": enum, "message": string, "data": [ { "key": string, "value": string } ] } ], "httpErrorStatusCode": integer, "httpErrorMessage": string, "selfLink": string, "region": string, "description": string, "operationGroupId": string, // Union field |
Fields | |
---|---|
kind |
[Output Only] Type of resource. Always |
id |
[Output Only] The unique identifier for the resource. This identifier is defined by the server. |
items |
[Output Only] A map of scoped operation lists. Key: [Output Only] Name of the scope containing this set of operations. |
items.operations[] |
[Output Only] A list of operations contained in this scope. |
items.operations[].kind |
[Output Only] Type of the resource. Always |
items.operations[].id |
[Output Only] The unique identifier for the operation. This identifier is defined by the server. |
items.operations[].creationTimestamp |
[Deprecated] This field is deprecated. |
items.operations[].name |
[Output Only] Name of the operation. |
items.operations[].zone |
[Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. |
items.operations[].clientOperationId |
[Output Only] The value of |
items.operations[].operationType |
[Output Only] The type of operation, such as |
items.operations[].targetLink |
[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.operations[].targetId |
[Output Only] The unique target ID, which identifies a specific incarnation of the target resource. |
items.operations[].status |
[Output Only] The status of the operation, which can be one of the following: |
items.operations[].statusMessage |
[Output Only] An optional textual description of the current status of the operation. |
items.operations[].user |
[Output Only] User who requested the operation, for example: |
items.operations[].progress |
[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.operations[].insertTime |
[Output Only] The time that this operation was requested. This value is in RFC3339 text format. |
items.operations[].startTime |
[Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. |
items.operations[].endTime |
[Output Only] The time that this operation was completed. This value is in RFC3339 text format. |
items.operations[].error |
[Output Only] If errors are generated during processing of the operation, this field will be populated. |
items.operations[].error.errors[] |
[Output Only] The array of errors encountered while processing this operation. |
items.operations[].error.errors[].code |
[Output Only] The error type identifier for this error. |
items.operations[].error.errors[].location |
[Output Only] Indicates the field in the request that caused the error. This property is optional. |
items.operations[].error.errors[].message |
[Output Only] An optional, human-readable error message. |
items.operations[].error.errors[].errorDetails[] |
[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.operations[].error.errors[].errorDetails[].errorInfo |
|
items.operations[].error.errors[].errorDetails[].errorInfo.reason |
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 |
items.operations[].error.errors[].errorDetails[].errorInfo.domain |
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.operations[].error.errors[].errorDetails[].errorInfo.metadatas |
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.operations[].error.errors[].errorDetails[].quotaInfo |
|
items.operations[].error.errors[].errorDetails[].quotaInfo.metricName |
The Compute Engine quota metric name. |
items.operations[].error.errors[].errorDetails[].quotaInfo.limitName |
The name of the quota limit. |
items.operations[].error.errors[].errorDetails[].quotaInfo.dimensions |
The map holding related quota dimensions. |
items.operations[].error.errors[].errorDetails[].quotaInfo.limit |
Current effective quota limit. The limit's unit depends on the quota type or metric. |
items.operations[].error.errors[].errorDetails[].quotaInfo.futureLimit |
Future quota limit being rolled out. The limit's unit depends on the quota type or metric. |
items.operations[].error.errors[].errorDetails[].quotaInfo.rolloutStatus |
Rollout status of the future quota limit. |
items.operations[].error.errors[].errorDetails[].help |
|
items.operations[].error.errors[].errorDetails[].help.links[] |
URL(s) pointing to additional information on handling the current error. |
items.operations[].error.errors[].errorDetails[].help.links[].description |
Describes what the link offers. |
items.operations[].error.errors[].errorDetails[].help.links[].url |
The URL of the link. |
items.operations[].error.errors[].errorDetails[].localizedMessage |
|
items.operations[].error.errors[].errorDetails[].localizedMessage.locale |
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.operations[].error.errors[].errorDetails[].localizedMessage.message |
The localized error message in the above locale. |
items.operations[].warnings[] |
[Output Only] If warning messages are generated during processing of the operation, this field will be populated. |
items.operations[].warnings[].code |
[Output Only] A warning code, if applicable. For example, Compute Engine returns |
items.operations[].warnings[].message |
[Output Only] A human-readable description of the warning code. |
items.operations[].warnings[].data[] |
[Output Only] Metadata about this warning in "data": [ { "key": "scope", "value": "zones/us-east1-d" } |
items.operations[].warnings[].data[].key |
[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 |
items.operations[].warnings[].data[].value |
[Output Only] A warning data value corresponding to the key. |
items.operations[].httpErrorStatusCode |
[Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a |
items.operations[].httpErrorMessage |
[Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as |
items.operations[].selfLink |
[Output Only] Server-defined URL for the resource. |
items.operations[].region |
[Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. |
items.operations[].description |
[Output Only] A textual description of the operation, which is set when the operation is created. |
items.operations[].operationGroupId |
[Output Only] An ID that represents a group of operations, such as when a group of operations results from a |
items.operations[].setCommonInstanceMetadataOperationMetadata |
[Output Only] If the operation is for projects.setCommonInstanceMetadata, this field will contain information on all underlying zonal actions and their state. |
items.operations[].setCommonInstanceMetadataOperationMetadata.clientOperationId |
[Output Only] The client operation id. |
items.operations[].setCommonInstanceMetadataOperationMetadata.perLocationOperations[] |
[Output Only] Status information per location (location name is key). Example key: zones/us-central1-a |
items.operations[].setCommonInstanceMetadataOperationMetadata.perLocationOperations[].state |
[Output Only] Status of the action, which can be one of the following: |
items.operations[].setCommonInstanceMetadataOperationMetadata.perLocationOperations[].error |
[Output Only] If state is |
items.operations[].setCommonInstanceMetadataOperationMetadata.perLocationOperations[].error.code |
The status code, which should be an enum value of |
items.operations[].setCommonInstanceMetadataOperationMetadata.perLocationOperations[].error.message |
A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the |
items.operations[].setCommonInstanceMetadataOperationMetadata.perLocationOperations[].error.details[] |
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 |
items.operations[].instancesBulkInsertOperationMetadata |
|
items.operations[].instancesBulkInsertOperationMetadata.perLocationStatus[] |
Status information per location (location name is key). Example key: zones/us-central1-a |
items.operations[].instancesBulkInsertOperationMetadata.perLocationStatus[].status |
[Output Only] Creation status of BulkInsert operation - information if the flow is rolling forward or rolling back. |
items.operations[].instancesBulkInsertOperationMetadata.perLocationStatus[].targetVmCount |
[Output Only] Count of VMs originally planned to be created. |
items.operations[].instancesBulkInsertOperationMetadata.perLocationStatus[].createdVmCount |
[Output Only] Count of VMs successfully created so far. |
items.operations[].instancesBulkInsertOperationMetadata.perLocationStatus[].failedToCreateVmCount |
[Output Only] Count of VMs that started creating but encountered an error. |
items.operations[].instancesBulkInsertOperationMetadata.perLocationStatus[].deletedVmCount |
[Output Only] Count of VMs that got deleted during rollback. |
items.warning |
[Output Only] Informational warning which replaces the list of operations when the list is empty. |
items.warning.code |
[Output Only] A warning code, if applicable. For example, Compute Engine returns |
items.warning.message |
[Output Only] A human-readable description of the warning code. |
items.warning.data[] |
[Output Only] Metadata about this warning in "data": [ { "key": "scope", "value": "zones/us-east1-d" } |
items.warning.data[].key |
[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 |
items.warning.data[].value |
[Output Only] A warning data value corresponding to the key. |
nextPageToken |
[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than |
selfLink |
[Output Only] Server-defined URL for this resource. |
warning |
[Output Only] Informational warning message. |
warning.code |
[Output Only] A warning code, if applicable. For example, Compute Engine returns |
warning.message |
[Output Only] A human-readable description of the warning code. |
warning.data[] |
[Output Only] Metadata about this warning in "data": [ { "key": "scope", "value": "zones/us-east1-d" } |
warning.data[].key |
[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 |
warning.data[].value |
[Output Only] A warning data value corresponding to the key. |
unreachables[] |
[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.globalOperations.list
To find predefined roles that contain those permissions, see Compute Engine IAM Roles.