Method: instances.getPartnerMetadata

Gets partner metadata of the specified instance and namespaces.

HTTP request

GET https://compute.googleapis.com/compute/beta/projects/{project}/zones/{zone}/instances/{instance}/getPartnerMetadata

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
project

string

Project ID for this request.
zone

string

The name of the zone for this request.
instance

string

Name of the instance scoping this request.

Query parameters

Parameters
namespaces

string

Comma separated partner metadata namespaces.

Request body

The request body must be empty.

Response body

Model definition of partnerMetadata field. To be used in dedicated Partner Metadata methods and to be inlined in the Instance and InstanceTemplate resources.

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

JSON representation 
{
  "partnerMetadata": {
    string: {
      "entries": {
        string: value,
        ...
      }
    },
    ...
  },
  "fingerprint": string
}
Fields
partnerMetadata[]

map (key: string, value: object)

Partner Metadata assigned to the instance. A map from a subdomain to entries map. Subdomain name must be compliant with RFC1035 definition. The total size of all keys and values must be less than 2MB. Subdomain 'metadata.compute.googleapis.com' is reserverd for instance's metadata.
partnerMetadata[].entries

map (key: string, value: value (Value format))

Map of a partner metadata that belong to the same subdomain. It accepts any value including google.protobuf.Struct.
fingerprint

string (bytes format)

Instance-level hash to be used for optimistic locking.

A base64-encoded string.

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.instances.get

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