Method: instances.getGuestAttributes

Returns the specified guest attributes entry.

HTTP request

GET https://www.googleapis.com/compute/beta/projects/{project}/zones/{zone}/instances/{resourceId}/getGuestAttributes

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.

resourceId

string

Name of the instance scoping this request.

Query parameters

Parameters
variableKey

string

Specifies the key for the guest attributes entry.

queryPath

string

Specifies the guest attributes path to be queried.

Request body

The request body must be empty.

Response body

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

A guest attributes entry.

JSON representation
{
  "variableKey": string,
  "variableValue": string,
  "queryPath": string,
  "queryValue": {
    "items": [
      {
        "namespace": string,
        "key": string,
        "value": string
      }
    ]
  },
  "selfLink": string,
  "kind": string
}
Fields
variableKey

string

The key to search for.

variableValue

string

[Output Only] The value found for the requested key.

queryPath

string

The path to be queried. This can be the default namespace ('/') or a nested namespace ('//') or a specified key ('//')

queryValue

object

[Output Only] The value of the requested queried path.

queryValue.items[]

object

queryValue.items[].namespace

string

Namespace for the guest attribute entry.

queryValue.items[].key

string

Key for the guest attribute entry.

queryValue.items[].value

string

Value for the guest attribute entry.

kind

string

[Output Only] Type of the resource. Always compute#guestAttributes for guest attributes entry.

Authorization Scopes

Requires one of the following OAuth scopes:

  • 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 Google IAM permissions:

  • compute.instances.getGuestAttributes
Was this page helpful? Let us know how we did:

Send feedback about...

Compute Engine