Method: projects.setCommonInstanceMetadata  |  Compute Engine Documentation  |  Google Cloud (original) (raw)

Sets metadata common to all instances within the specified project using the data included in the request.

HTTP request

POST https://compute.googleapis.com/compute/v1/projects/{project}/setCommonInstanceMetadata

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
project string Project ID for this request.

Query parameters

Parameters
requestId string An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Request body

The request body contains data with the following structure:

JSON representation
{ "kind": string, "fingerprint": string, "items": [ { "key": string, "value": string } ] }
Fields
kind string [Output Only] Type of the resource. Always compute#metadata for metadata.
fingerprint string (bytes format) Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata, otherwise the request will fail with error 412 conditionNotMet.To see the latest fingerprint, make a get() request to retrieve the resource.A base64-encoded string.
items[] object Array of key/value pairs. The total size of all keys and values must be less than 512 KB.
items[].key string [REQUIRED] Key for the metadata entry. Keys must conform to the following regexp: [a-zA-Z0-9-_]+, and be less than 128 bytes in length. This is reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project.
items[].value string [REQUIRED] Value for the metadata entry. These are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on values is that their size must be less than or equal to 262144 bytes (256 KiB).

Response body

Represents an Operation resource.

Google Compute Engine has three Operation resources:

You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

Operations can be global, regional or zonal.

For more information, read Global, Regional, and Zonal Resources.

Note that completed Operation resources have a limited retention period.

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

JSON representation
{ "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 metadata can be only one of the following: "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 }, ... } } // End of list of possible types for union field metadata. }
Fields
kind string [Output Only] Type of the resource. Always compute#operation for Operation resources.
id string (uint64 format) [Output Only] The unique identifier for the operation. This identifier is defined by the server.
creationTimestamp string [Deprecated] This field is deprecated.
name string [Output Only] Name of the operation.
zone string [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
clientOperationId string [Output Only] The value of requestId if you provided it in the request. Not present otherwise.
operationType string [Output Only] The type of operation, such as insert, update, or delete, and so on.
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.
targetId string (uint64 format) [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
status enum [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
statusMessage string [Output Only] An optional textual description of the current status of the operation.
user string [Output Only] User who requested the operation, for example: user@example.com or alice_smith_identifier (global/workforcePools/example-com-us-employees).
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.
insertTime string [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
startTime string [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
endTime string [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
error object [Output Only] If errors are generated during processing of the operation, this field will be populated.
error.errors[] object [Output Only] The array of errors encountered while processing this operation.
error.errors[].code string [Output Only] The error type identifier for this error.
error.errors[].location string [Output Only] Indicates the field in the request that caused the error. This property is optional.
error.errors[].message string [Output Only] An optional, human-readable error message.
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.
error.errors[].errorDetails[].errorInfo object
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.
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".
error.errors[].errorDetails[].errorInfo.metadatas map (key: string, value: string) Additional structured details about this error.Keys must match a regular expression of [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.
error.errors[].errorDetails[].quotaInfo object
error.errors[].errorDetails[].quotaInfo.metricName string The Compute Engine quota metric name.
error.errors[].errorDetails[].quotaInfo.limitName string The name of the quota limit.
error.errors[].errorDetails[].quotaInfo.dimensions map (key: string, value: string) The map holding related quota dimensions.
error.errors[].errorDetails[].quotaInfo.limit number Current effective quota limit. The limit's unit depends on the quota type or metric.
error.errors[].errorDetails[].quotaInfo.futureLimit number Future quota limit being rolled out. The limit's unit depends on the quota type or metric.
error.errors[].errorDetails[].quotaInfo.rolloutStatus enum Rollout status of the future quota limit.
error.errors[].errorDetails[].help object
error.errors[].errorDetails[].help.links[] object URL(s) pointing to additional information on handling the current error.
error.errors[].errorDetails[].help.links[].description string Describes what the link offers.
error.errors[].errorDetails[].help.links[].url string The URL of the link.
error.errors[].errorDetails[].localizedMessage object
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"
error.errors[].errorDetails[].localizedMessage.message string The localized error message in the above locale.
warnings[] object [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
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.
warnings[].message string [Output Only] A human-readable description of the warning code.
warnings[].data[] object [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }
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).
warnings[].data[].value string [Output Only] A warning data value corresponding to the key.
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.
httpErrorMessage string [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
selfLink string [Output Only] Server-defined URL for the resource.
region string [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
description string [Output Only] A textual description of the operation, which is set when the operation is created.
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.
Union field metadata. [Output Only] Service-specific metadata attached to this operation. metadata can be only one of the following:
setCommonInstanceMetadataOperationMetadata object [Output Only] If the operation is for projects.setCommonInstanceMetadata, this field will contain information on all underlying zonal actions and their state.
setCommonInstanceMetadataOperationMetadata.clientOperationId string [Output Only] The client operation id.
setCommonInstanceMetadataOperationMetadata.perLocationOperations[] map (key: string, value: object) [Output Only] Status information per location (location name is key). Example key: zones/us-central1-a
setCommonInstanceMetadataOperationMetadata.perLocationOperations[].state enum [Output Only] Status of the action, which can be one of the following: PROPAGATING, PROPAGATED, ABANDONED, FAILED, or DONE.
setCommonInstanceMetadataOperationMetadata.perLocationOperations[].error object [Output Only] If state is ABANDONED or FAILED, this field is populated.
setCommonInstanceMetadataOperationMetadata.perLocationOperations[].error.code integer The status code, which should be an enum value of google.rpc.Code.
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.
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" }.
instancesBulkInsertOperationMetadata object
instancesBulkInsertOperationMetadata.perLocationStatus[] map (key: string, value: object) Status information per location (location name is key). Example key: zones/us-central1-a
instancesBulkInsertOperationMetadata.perLocationStatus[].status enum [Output Only] Creation status of BulkInsert operation - information if the flow is rolling forward or rolling back.
instancesBulkInsertOperationMetadata.perLocationStatus[].targetVmCount integer [Output Only] Count of VMs originally planned to be created.
instancesBulkInsertOperationMetadata.perLocationStatus[].createdVmCount integer [Output Only] Count of VMs successfully created so far.
instancesBulkInsertOperationMetadata.perLocationStatus[].failedToCreateVmCount integer [Output Only] Count of VMs that started creating but encountered an error.
instancesBulkInsertOperationMetadata.perLocationStatus[].deletedVmCount integer [Output Only] Count of VMs that got deleted during rollback.

Requires one of the following OAuth scopes:

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:

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