Instances: setMetadata

Sets metadata for the specified instance to the data included in the request. Try it now .

Request

HTTP request

POST https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance/setMetadata

Parameters

Parameter name	Value	Description
Path parameters
`instance`	`string`	Name of the instance scoping this request.
`project`	`string`	Project ID of the project for this request.
`zone`	`string`	Name of the zone scoping this request.

Authorization

This request requires authorization with the following scope ( read more about authentication and authorization ).

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

Request body

In the request body, supply data with the following structure:

{
  "kind": "compute#metadata",
  "fingerprint": bytes,
  "items": [
    {
      "key": string,
      "value": string
    }
  ]
}

Property name	Value	Description
`kind`	`string`	The type of resource. Always `compute#instanceList` for lists of Instance resource. This is automatically supplied by the server.
`fingerprint`	`bytes`	Current fingerprint of this resource. You must provide the current version of the fingerprint to successfully update any metadata. This helps to perform optimistic locking. An up-to-date metadata fingerprint must be provided in order to modify metadata.
`items[]`	`list`	Array of key/value pairs. The total size of all keys and values must be less than 512 KB.
`items[]. key`	`string`	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`	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 32768 bytes.

Response

If successful, this method returns a ZoneOperations resource in the response body.

{
  "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
}

Property name	Value	Description
`clientOperationId`	`string`	[Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project.
`creationTimestamp`	`string`	[Output Only] Creation timestamp in RFC3339 text format.
`endTime`	`string`	[Output Only] The time that this operation was completed. This is in RFC3339 text format.
`error`	`object`	[Output Only] If errors occurred during processing of this operation, this field will be populated.
`error. errors[]`	`list`	[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 which caused the error. This property is optional.
`error.errors[]. message`	`string`	[Output Only] An optional, human-readable error message.
`httpErrorMessage`	`string`	[Output Only] If operation fails, the HTTP error message returned, e.g. `NOT FOUND` .
`httpErrorStatusCode`	`integer`	[Output Only] If operation fails, the HTTP error status code returned, e.g. `404` .
`id`	`unsigned long`	[Output Only] Unique identifier for the resource, generated by the server.
`insertTime`	`string`	[Output Only] The time that this operation was requested. This is in RFC3339 text format.
`kind`	`string`	[Output Only] Type of the resource. Always `compute#operation` for Operation resources.
`name`	`string`	[Output Only] Name of the resource.
`operationType`	`string`	[Output Only] Type of the operation. Operations include `insert` , `update` , and `delete` .
`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 at when the operation will be complete. This number should be monotonically increasing as the operation progresses.
`region`	`string`	[Output Only] URL of the region where the operation resides. Only available when performing regional operations.
`selfLink`	`string`	[Output Only] Server-defined fully-qualified URL for this resource.
`startTime`	`string`	[Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
`status`	`string`	[Output Only] Status of the operation. Acceptable values are: " `DONE` ": The operation has finished. " `PENDING` ": The operation is pending and not yet run. " `RUNNING` ": The operation is currently running.
`statusMessage`	`string`	[Output Only] An optional textual description of the current status of the operation.
`targetId`	`unsigned long`	[Output Only] Unique target id which identifies a particular incarnation of the target.
`targetLink`	`string`	[Output Only] URL of the resource the operation is mutating.
`user`	`string`	[Output Only] User who requested the operation, for example: `[email protected]` .
`warnings[]`	`list`	[Output Only] If there are issues with this operation, a warning is returned.
`warnings[]. code`	`string`	[Output Only] The warning type identifier for this warning. Acceptable values are: " `DEPRECATED_RESOURCE_USED` ": Indicates that you are using a deprecated resource and should transition to using a more current resource. " `INJECTED_KERNELS_DEPRECATED` ": Indicates that specifying a separate Kernel resource is deprecated. You should transition to using images that contain kernel binaries. See Kernels for more information. " `NEXT_HOP_ADDRESS_NOT_ASSIGNED` ": You did not specify a next hop address for your route. " `NEXT_HOP_CANNOT_IP_FORWARD` ": In order for your route to work correctly, your source and destination virtual machine instances must have canIpForward enabled. See the documentation for more information. " `NEXT_HOP_INSTANCE_NOT_FOUND` ": The next hop instance you specified was not found. Please double check that the instance exists and that you have specified it correctly. " `NEXT_HOP_INSTANCE_NOT_ON_NETWORK` ": The next hop instance you specified was not found on the same network as your route object. Please make sure the instance is part of the same network as your route object. " `NEXT_HOP_NOT_RUNNING` ": The next hop instance you specified is not currently running. Please restart or create the instnce. " `NO_RESULTS_ON_PAGE` ": There were no results for your request. " `REQUIRED_TOS_AGREEMENT` ": You must first agree to the terms of service agreement before you can use this service. " `UNREACHABLE` ": The Compute Engine service is currently unreachable.
`warnings[]. data[]`	`list`	[Output Only] Metadata for this warning in 'key: value' format.
`warnings[].data[]. key`	`string`	[Output Only] Metadata key for this warning.
`warnings[].data[]. value`	`string`	[Output Only] Metadata value for the specified key.
`warnings[]. message`	`string`	[Output Only] Optional human-readable details for this warning.
`zone`	`string`	[Output Only] URL of the zone where the operation resides. Only available when performing per-zone operations.

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 .

Last updated December 3, 2013.

Google Compute Engine