- HTTP request
- Path parameters
- Request body
- Response body
- Authorization scopes
- GuestAttributes
- GuestAttributesValue
- GuestAttributesEntry
- Try it!
Retrieves the guest attributes for the node.
HTTP request
POST https://tpu.googleapis.com/v2alpha1/{name=projects/*/locations/*/nodes/*}:getGuestAttributes
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
name |
Required. The resource name. |
Request body
The request body contains data with the following structure:
JSON representation |
---|
{ "queryPath": string, "workerIds": [ string ] } |
Fields | |
---|---|
queryPath |
The guest attributes path to be queried. |
workerIds[] |
The 0-based worker ID. If it is empty, all workers' GuestAttributes will be returned. |
Response body
Response for nodes.getGuestAttributes
.
If successful, the response body contains data with the following structure:
JSON representation |
---|
{
"guestAttributes": [
{
object ( |
Fields | |
---|---|
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 the Authentication Overview.
GuestAttributes
A guest attributes.
JSON representation |
---|
{
"queryPath": string,
"queryValue": {
object ( |
Fields | |
---|---|
queryPath |
The path to be queried. This can be the default namespace ('/') or a nested namespace ('/<namespace>/') or a specified key ('/<namespace>/<key>') |
queryValue |
The value of the requested queried path. |
GuestAttributesValue
Array of guest attribute namespace/key/value tuples.
JSON representation |
---|
{
"items": [
{
object ( |
Fields | |
---|---|
items[] |
The list of guest attributes entries. |
GuestAttributesEntry
A guest attributes namespace/key/value entry.
JSON representation |
---|
{ "namespace": string, "key": string, "value": string } |
Fields | |
---|---|
namespace |
Namespace for the guest attribute entry. |
key |
Key for the guest attribute entry. |
value |
Value for the guest attribute entry. |