Console
    Contact Us Start free

    Method: instances.getGuestAttributes

    Returns the specified guest attributes entry.

    HTTP request

    GET https://compute.googleapis.com/compute/v1/projects/{project}/zones/{zone}/instances/{instance}/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.
    instance

    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

    A guest attributes entry.

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

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

    string

    [Output Only] Type of the resource. Always compute#guestAttributes for guest attributes entry.
    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 ('<namespace>/') or a specified key ('<namespace>/<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.

    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.getGuestAttributes

    To find predefined roles that contain those permissions, see Compute Engine IAM Roles .
    Create a Mobile Website
    View Site in Mobile | Classic
    Share by: