Method: nodeTemplates.get

Returns the specified node template. Gets a list of available node templates by making a list() request.

HTTP request

GET https://www.googleapis.com/compute/beta/projects/{project}/regions/{region}/nodeTemplates/{resourceId}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
project

string

Project ID for this request.

region

string

The name of the region for this request.

resourceId

string

Name of the node template to return.

Request body

The request body must be empty.

Response body

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

A Node Template resource.

JSON representation
{
  "id": string,
  "creationTimestamp": string,
  "name": string,
  "description": string,
  "nodeType": string,
  "nodeAffinityLabels": {
    string: string,
    ...
  },
  "status": enum,
  "statusMessage": string,
  "region": string,
  "selfLink": string,
  "nodeTypeFlexibility": {
    "cpus": string,
    "memory": string,
    "localSsd": string
  },
  "kind": string
}
Fields
id

string (fixed64 format)

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

creationTimestamp

string

[Output Only] Creation timestamp in RFC3339 text format.

name

string

The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

description

string

An optional description of this resource. Provide this property when you create the resource.

nodeType

string

The node type to use for nodes group that are created from this template.

nodeAffinityLabels

map (key: string, value: string)

Labels to use for node affinity, which will be used in instance scheduling.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

status

enum

[Output Only] The status of the node template. One of the following values: CREATING, READY, and DELETING.

statusMessage

string

[Output Only] An optional, human-readable explanation of the status.

region

string

[Output Only] The name of the region where the node template resides, such as us-central1.

nodeTypeFlexibility

object

The flexible properties of the desired node type. Node groups that use this node template will create nodes of a type that matches these properties.

This field is mutually exclusive with the nodeType property; you can only define one or the other, but not both.

nodeTypeFlexibility.cpus

string

nodeTypeFlexibility.memory

string

nodeTypeFlexibility.localSsd

string

kind

string

[Output Only] The type of the resource. Always compute#nodeTemplate for node templates.

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.nodeTemplates.get
Was this page helpful? Let us know how we did:

Send feedback about...

Compute Engine