Method: nodeTemplates.list

Retrieves a list of node templates available to the specified project.

HTTP request

GET https://compute.googleapis.com/compute/v1/projects/{project}/regions/{region}/nodeTemplates

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.

Query parameters

Parameters
maxResults

integer (uint32 format)

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)
pageToken

string

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
filter

string

A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.

For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.

You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true).
orderBy

string

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.

Request body

The request body must be empty.

Response body

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

JSON representation 
{
  "id": string,
  "items": [
    {
      "id": string,
      "creationTimestamp": string,
      "name": string,
      "description": string,
      "nodeType": string,
      "nodeAffinityLabels": {
        object
      },
      "status": enum,
      "statusMessage": string,
      "region": string,
      "selfLink": string,
      "nodeTypeFlexibility": {
        "cpus": string,
        "memory": string,
        "localSsd": string
      },
      "serverBinding": {
        "type": enum
      },
      "kind": string
    }
  ],
  "nextPageToken": string,
  "selfLink": string,
  "warning": {
    "code": enum,
    "message": string,
    "data": [
      {
        "key": string,
        "value": string
      }
    ]
  },
  "kind": string
}
Fields
id

string

[Output Only] Unique identifier for the resource; defined by the server.
items[]

object

A list of NodeTemplate resources.
items[].id

string (fixed64 format)

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

string

[Output Only] Creation timestamp in RFC3339 text format.
items[].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.
items[].description

string

An optional description of this resource. Provide this property when you create the resource.
items[].nodeType

string

The node type to use for nodes group that are created from this template.
items[].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" }.
items[].status

enum

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

string

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

string

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

string

[Output Only] Server-defined URL for the resource.
items[].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.
items[].nodeTypeFlexibility.cpus

string
items[].nodeTypeFlexibility.memory

string
items[].nodeTypeFlexibility.localSsd

string
items[].serverBinding

object

Sets the binding properties for the physical server. Valid values include:

  • [Default] RESTART_NODE_ON_ANY_SERVER: Restarts VMs on any available physical server
  • RESTART_NODE_ON_MINIMAL_SERVER: Restarts VMs on the same physical server whenever possible

See Sole-tenant node options for more information.
items[].serverBinding.type

enum
items[].kind

string

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

string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
warning

object

[Output Only] Informational warning message.
warning.code

enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
warning.message

string

[Output Only] A human-readable description of the warning code.
warning.data[]

object

[Output Only] Metadata about this warning in key: value format. For example: 

"data": [  {  "key": "scope",  "value": "zones/us-east1-d"  }
warning.data[].key

string

[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
warning.data[].value

string

[Output Only] A warning data value corresponding to the key.
kind

string

[Output Only] Type of resource.Always compute#nodeTemplateList for lists of 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.list