Method: projects.locations.nodes.getGuestAttributes

Retrieves the guest attributes for the node.

HTTP request

POST https://tpu.googleapis.com/v2/{name=projects/*/locations/*/nodes/*}:getGuestAttributes

The URL usesgRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. The resource name.

Request body

The request body contains data with the following structure:

JSON representation
{"queryPath":string,"workerIds":[string]}
Fields
queryPath

string

The guest attributes path to be queried.

workerIds[]

string

The 0-based worker ID. If it is empty, all workers' GuestAttributes will be returned.

Response body

Response fornodes.getGuestAttributes.

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

JSON representation
{"guestAttributes":[{object (GuestAttributes)}]}
Fields
guestAttributes[]

object (GuestAttributes)

The guest attributes for the TPU workers.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud.tpu
  • https://www.googleapis.com/auth/cloud-platform

For more information, see theAuthentication Overview.

GuestAttributes

A guest attributes.

JSON representation
{"queryPath":string,"queryValue":{object (GuestAttributesValue)}}
Fields
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 (GuestAttributesValue)

The value of the requested queried path.

GuestAttributesValue

Array of guest attribute namespace/key/value tuples.

JSON representation
{"items":[{object (GuestAttributesEntry)}]}
Fields
items[]

object (GuestAttributesEntry)

The list of guest attributes entries.

GuestAttributesEntry

A guest attributes namespace/key/value entry.

JSON representation
{"namespace":string,"key":string,"value":string}
Fields
namespace

string

Namespace for the guest attribute entry.

key

string

Key for the guest attribute entry.

value

string

Value for the guest attribute entry.

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-06-17 UTC.