REST Resource: nodeTemplates

Resource: NodeTemplate

Represent a sole-tenant Node Template resource.

You can use a template to define properties for nodes in a node group. For more information, read Creating node groups and instances.

JSON representation 
{
  "kind": string,
  "id": string,
  "creationTimestamp": string,
  "name": string,
  "description": string,
  "nodeType": string,
  "nodeAffinityLabels": {
    string: string,
    ...
  },
  "status": enum (Status),
  "statusMessage": string,
  "region": string,
  "selfLink": string,
  "nodeTypeFlexibility": {
    object (NodeTypeFlexibility)
  },
  "serverBinding": {
    object (ServerBinding)
  },
  "disks": [
    {
      object (LocalDisk)
    }
  ],
  "accelerators": [
    {
      object (AcceleratorConfig)
    }
  ],
  "cpuOvercommitType": enum (CpuOvercommitType)
}
Fields
kind

string

[Output Only] The type of the resource. Always

compute#nodeTemplate

for node templates.
id

string (uint64 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.
status

enum (Status)

[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 (NodeTypeFlexibility)

Do not use. Instead, use the

nodeType

property.
serverBinding

object (ServerBinding)

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.
disks[]

object (LocalDisk)
accelerators[]

object (AcceleratorConfig)
cpuOvercommitType

enum (CpuOvercommitType)

CPU overcommit.

Status

Enums
INVALID Invalid status.
CREATING Resources are being allocated.
READY The node template is ready.
DELETING The node template is currently being deleted.

NodeTypeFlexibility

JSON representation 
{
  "cpus": string,
  "memory": string,
  "localSsd": string
}
Fields
cpus

string
memory

string
localSsd

string

ServerBinding

JSON representation 
{
  "type": enum (ServerBindingType)
}
Fields
type

enum (ServerBindingType)

ServerBindingType

Enums
SERVER_BINDING_TYPE_UNSPECIFIED
RESTART_NODE_ON_ANY_SERVER Node may associate with any physical server over its lifetime.
RESTART_NODE_ON_MINIMAL_SERVERS Node may associate with minimal physical servers over its lifetime.

LocalDisk

JSON representation 
{
  "diskType": string,
  "diskSizeGb": integer,
  "diskCount": integer
}
Fields
diskType

string

Specifies the desired disk type on the node. This disk type must be a local storage type (e.g.:

local-ssd

). Note that for nodeTemplates, this should be the name of the disk type and not its URL.
diskSizeGb

integer

Specifies the size of the disk in base-2 GB.
diskCount

integer

Specifies the number of such disks.

CpuOvercommitType

Enums
CPU_OVERCOMMIT_TYPE_UNSPECIFIED
NONE
ENABLED

Methods

aggregatedList

 The method compute.v1.NodeTemplatesService.AggregatedList is not available in this (s3nsapis.fr) universe.

delete

 The method compute.v1.NodeTemplatesService.Delete is not available in this (s3nsapis.fr) universe.

get

 The method compute.v1.NodeTemplatesService.Get is not available in this (s3nsapis.fr) universe.

getIamPolicy

 The method compute.v1.NodeTemplatesService.GetPolicy is not available in this (s3nsapis.fr) universe.

insert

 The method compute.v1.NodeTemplatesService.Insert is not available in this (s3nsapis.fr) universe.

list

 The method compute.v1.NodeTemplatesService.List is not available in this (s3nsapis.fr) universe.

setIamPolicy

 The method compute.v1.NodeTemplatesService.SetPolicy is not available in this (s3nsapis.fr) universe.

testIamPermissions

 The method compute.v1.NodeTemplatesService.TestPermissions is not available in this (s3nsapis.fr) universe.