Method: instanceTemplates.get

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

HTTP request

GET https://www.googleapis.com/compute/beta/projects/{project}/global/instanceTemplates/{resourceId}

The URL uses Google API HTTP annotation syntax.

Path parameters

Parameters
project

string

Project ID for this request.

resourceId

string

The name of the instance template.

Request body

The request body must be empty.

Response body

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

An Instance Template resource.

JSON representation
{
  "id": string,
  "creationTimestamp": string,
  "name": string,
  "description": string,
  "properties": {
    "description": string,
    "tags": {
      "items": [
        string
      ],
      "fingerprint": string
    },
    "machineType": string,
    "canIpForward": boolean,
    "networkInterfaces": {
      "network": string,
      "subnetwork": string,
      "networkIP": string,
      "name": string,
      "accessConfigs": [
        {
          "type": enum,
          "name": string,
          "natIP": string,
          "setPublicPtr": boolean,
          "publicPtrDomainName": string,
          "networkTier": enum,
          "kind": string
        }
      ],
      "aliasIpRanges": [
        {
          "ipCidrRange": string,
          "subnetworkRangeName": string
        }
      ],
      "fingerprint": string,
      "kind": string
    },
    "disks": {
      "type": enum,
      "mode": enum,
      "source": string,
      "deviceName": string,
      "index": number,
      "boot": boolean,
      "initializeParams": {
        "diskName": string,
        "sourceImage": string,
        "diskSizeGb": string,
        "diskStorageType": enum,
        "diskType": string,
        "sourceImageEncryptionKey": {
          "sha256": string,

          
          "rawKey": string,
          "rsaEncryptedKey": string,
          "kmsKeyName": string
          
        },
        "labels": {
          "key": string,
          "value": string
        }
      },
      "autoDelete": boolean,
      "licenses": [
        string
      ],
      "interface": enum,
      "guestOsFeatures": [
        {
          "type": enum
        }
      ],
      "diskEncryptionKey": {
        "rawKey": string,
        "rsaEncryptedKey": string,
        "kmsKeyName": string,
        "sha256": string
      },
      "kind": string
    },
    "metadata": {
      "fingerprint": string,
      "items": [
        {
          "key": string,
          "value": string
        }
      ],
      "kind": string
    },
    "serviceAccounts": {
      "email": string,
      "scopes": [
        string
      ]
    },
    "scheduling": {
      "onHostMaintenance": enum,
      "automaticRestart": boolean,
      "preemptible": boolean,
      "nodeAffinities": [
        {
          "key": string,
          "operator": enum,
          "values": string
        }
      ]
    },
    "labels": {
      "key": string,
      "value": string
    },
    "guestAccelerators": {
      "acceleratorType": string,
      "acceleratorCount": number
    },
    "minCpuPlatform": string,
  },
  "selfLink": string,
  "sourceInstance": string,
  "sourceInstanceParams": {
    "diskConfigs": {
      "deviceName": string,
      "instantiateFrom": enum,
      "autoDelete": boolean,
      "customImage": string
    }
  },
  "kind": string
}
Fields
id

string (fixed64 format)

[Output Only] A unique identifier for this instance template. The server defines this identifier.

creationTimestamp

string

[Output Only] The creation timestamp for this instance template in RFC3339 text format.

name

string

Name of the resource; provided by the client when the resource is created. The 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.

properties

object

The instance properties for this instance template.

properties.description

string

An optional text description for the instances that are created from this instance template.

properties.tags

object

A list of tags to apply to the instances that are created from this template. The tags identify valid sources or targets for network firewalls. The setTags method can modify this list of tags. Each tag within the list must comply with RFC1035.

properties.tags.items[]

string

An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035.

properties.tags.fingerprint

string (bytes format)

Specifies a fingerprint for this request, which is essentially a hash of the tags' contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update tags. You must always provide an up-to-date fingerprint hash in order to update or change tags.

To see the latest fingerprint, make get() request to the instance.

A base64-encoded string.

properties.machineType

string

The machine type to use for instances that are created from this template.

properties.canIpForward

boolean

Enables instances created based on this template to send packets with source IP addresses other than their own and receive packets with destination IP addresses other than their own. If these instances will be used as an IP gateway or it will be set as the next-hop in a Route resource, specify true. If unsure, leave this set to false. See the Enable IP forwarding documentation for more information.

properties.networkInterfaces[]

object

An array of network access configurations for this interface.

properties.networkInterfaces[].network

string

URL of the network resource for this instance. When creating an instance, if neither the network nor the subnetwork is specified, the default network global/networks/default is used; if the network is not specified but the subnetwork is specified, the network is inferred.

This field is optional when creating a firewall rule. If not specified when creating a firewall rule, the default network global/networks/default is used.

If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs:

properties.networkInterfaces[].subnetwork

string

The URL of the Subnetwork resource for this instance. If the network resource is in legacy mode, do not provide this property. If the network is in auto subnet mode, providing the subnetwork is optional. If the network is in custom subnet mode, then this field should be specified. If you specify this property, you can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs:

properties.networkInterfaces[].networkIP

string

An IPv4 internal network address to assign to the instance for this network interface. If not specified by the user, an unused internal IP is assigned by the system.

properties.networkInterfaces[].name

string

[Output Only] The name of the network interface, generated by the server. For network devices, these are eth0, eth1, etc.

properties.networkInterfaces[].accessConfigs[]

object

An array of configurations for this interface. Currently, only one access config, ONE_TO_ONE_NAT, is supported. If there are no accessConfigs specified, then this instance will have no external internet access.

properties.networkInterfaces[].accessConfigs[].type

enum

The type of configuration. The default and only option is ONE_TO_ONE_NAT.

properties.networkInterfaces[].accessConfigs[].name

string

The name of this access configuration. The default and recommended name is External NAT but you can use any arbitrary string you would like. For example, My external IP or Network Access.

properties.networkInterfaces[].accessConfigs[].natIP

string

An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance.

properties.networkInterfaces[].accessConfigs[].setPublicPtr

boolean

Specifies whether a public DNS ‘PTR’ record should be created to map the external IP address of the instance to a DNS domain name.

properties.networkInterfaces[].accessConfigs[].publicPtrDomainName

string

The DNS domain name for the public PTR record. This field can only be set when the setPublicPtr field is enabled.

properties.networkInterfaces[].accessConfigs[].networkTier

enum

This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD.

If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier.

If an AccessConfig with a valid external IP address is specified, it must match that of the networkTier associated with the Address resource owning that IP.

properties.networkInterfaces[].accessConfigs[].kind

string

[Output Only] Type of the resource. Always compute#accessConfig for access configs.

properties.networkInterfaces[].aliasIpRanges[]

object

An array of alias IP ranges for this network interface. Can only be specified for network interfaces on subnet-mode networks.

properties.networkInterfaces[].aliasIpRanges[].ipCidrRange

string

The IP CIDR range represented by this alias IP range. This IP CIDR range must belong to the specified subnetwork and cannot contain IP addresses reserved by system or used by other network interfaces. This range may be a single IP address (e.g. 10.2.3.4), a netmask (e.g. /24) or a CIDR format string (e.g. 10.1.2.0/24).

properties.networkInterfaces[].aliasIpRanges[].subnetworkRangeName

string

Optional subnetwork secondary range name specifying the secondary range from which to allocate the IP CIDR range for this alias IP range. If left unspecified, the primary range of the subnetwork will be used.

properties.networkInterfaces[].fingerprint

string (bytes format)

Fingerprint hash of contents stored in this network interface. This field will be ignored when inserting an Instance or adding a NetworkInterface. An up-to-date fingerprint must be provided in order to update the NetworkInterface.

A base64-encoded string.

properties.networkInterfaces[].kind

string

[Output Only] Type of the resource. Always compute#networkInterface for network interfaces.

properties.disks[]

object

An array of disks that are associated with the instances that are created from this template.

properties.disks[].type

enum

Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT.

properties.disks[].mode

enum

The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE mode.

properties.disks[].source

string

Specifies a valid partial or full URL to an existing Persistent Disk resource. When creating a new instance, one of initializeParams.sourceImage or disks.source is required except for local SSD.

If desired, you can also attach existing non-root persistent disks using this property. This field is only applicable for persistent disks.

Note that for InstanceTemplate, specify the disk name, not the URL for the disk.

properties.disks[].deviceName

string

Specifies a unique device name of your choice that is reflected into the /dev/disk/by-id/google-* tree of a Linux operating system running within the instance. This name can be used to reference the device for mounting, resizing, and so on, from within the instance.

If not specified, the server chooses a default device name to apply to this disk, in the form persistent-disks-x, where x is a number assigned by Google Compute Engine. This field is only applicable for persistent disks.

properties.disks[].index

number

[Output Only] A zero-based index to this disk, where 0 is reserved for the boot disk. If you have many disks attached to an instance, each disk would have a unique index number.

properties.disks[].boot

boolean

Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem.

properties.disks[].initializeParams

object

[Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance.

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

properties.disks[].initializeParams.diskName

string

Specifies the disk name. If not specified, the default is to use the name of the instance.

properties.disks[].initializeParams.sourceImage

string

The source image to create this disk. When creating a new instance, one of initializeParams.sourceImage or disks.source is required except for local SSD.

To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-8 to use the latest Debian 8 image:

projects/debian-cloud/global/images/family/debian-8

Alternatively, use a specific version of a public operating system image:

projects/debian-cloud/global/images/debian-8-jessie-vYYYYMMDD

To create a disk with a custom image that you created, specify the image name in the following format:

global/images/my-custom-image

You can also specify a custom image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name:

global/images/family/my-image-family

If the source image is deleted later, this field will not be set.

properties.disks[].initializeParams.diskSizeGb

string (int64 format)

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

properties.disks[].initializeParams.diskStorageType
(deprecated)

enum

[Deprecated] Storage type of the disk.

properties.disks[].initializeParams.diskType

string

Specifies the disk type to use to create the instance. If not specified, the default is pd-standard, specified using the full URL. For example:

https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard

Other values include pd-ssd and local-ssd. If you define this field, you can provide either the full or partial URL. For example, the following are valid values:

Note that for InstanceTemplate, this is the name of the disk type, not URL.

properties.disks[].initializeParams.sourceImageEncryptionKey

object

The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key.

Instance templates do not store customer-supplied encryption keys, so you cannot create disks for instances in a managed instance group if the source images are encrypted with your own keys.

properties.disks[].initializeParams.sourceImageEncryptionKey.rawKey

string

Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

properties.disks[].initializeParams.sourceImageEncryptionKey.rsaEncryptedKey

string

Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

The key must meet the following requirements before you can provide it to Compute Engine:

  1. The key is wrapped using a RSA public key certificate provided by Google.
  2. After being wrapped, the key must be encoded in RFC 4648 base64 encoding.
Gets the RSA public key certificate provided by Google at:
https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

properties.disks[].initializeParams.sourceImageEncryptionKey.kmsKeyName

string

The name of the encryption key that is stored in Google Cloud KMS.

properties.disks[].initializeParams.sourceImageEncryptionKey.sha256

string

[Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

properties.disks[].initializeParams.labels

map (key: string, value: string)

Labels to apply to this disk. These can be later modified by the disks.setLabels method. This field is only applicable for persistent disks.

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

properties.disks[].autoDelete

boolean

Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).

properties.disks[].licenses[]

string

[Output Only] Any valid publicly visible licenses.

properties.disks[].interface

enum

Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. Persistent disks must always use SCSI and the request will fail if you attempt to attach a persistent disk in any other format than SCSI. Local SSDs can use either NVME or SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance.

properties.disks[].guestOsFeatures[]

object

A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options.

properties.disks[].guestOsFeatures[].type

enum

The ID of a supported feature. Read Enabling guest operating system features to see a list of available options.

properties.disks[].diskEncryptionKey

object

Encrypts or decrypts a disk using a customer-supplied encryption key.

If you are creating a new disk, this field encrypts the new disk using an encryption key that you provide. If you are attaching an existing disk that is already encrypted, this field decrypts the disk using the customer-supplied encryption key.

If you encrypt a disk using a customer-supplied key, you must provide the same key again when you attempt to use this resource at a later time. For example, you must provide the key when you create a snapshot or an image from the disk or when you attach the disk to a virtual machine instance.

If you do not provide an encryption key, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the disk later.

Instance templates do not store customer-supplied encryption keys, so you cannot use your own keys to encrypt disks in a managed instance group.

properties.disks[].diskEncryptionKey.rawKey

string

Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

properties.disks[].diskEncryptionKey.rsaEncryptedKey

string

Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

The key must meet the following requirements before you can provide it to Compute Engine:

  1. The key is wrapped using a RSA public key certificate provided by Google.
  2. After being wrapped, the key must be encoded in RFC 4648 base64 encoding.
Gets the RSA public key certificate provided by Google at:
https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

properties.disks[].diskEncryptionKey.kmsKeyName

string

The name of the encryption key that is stored in Google Cloud KMS.

properties.disks[].diskEncryptionKey.sha256

string

[Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

properties.disks[].kind

string

[Output Only] Type of the resource. Always compute#attachedDisk for attached disks.

properties.metadata

object

The metadata key/value pairs to assign to instances that are created from this template. These pairs can consist of custom metadata or predefined keys. See Project and instance metadata for more information.

properties.metadata.fingerprint

string (bytes format)

Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.

A base64-encoded string.

properties.metadata.items[]

object

Array of key/value pairs. The total size of all keys and values must be less than 512 KB.

properties.metadata.items[].key

string

Key for the metadata entry. Keys must conform to the following regexp: [a-zA-Z0-9-_]+, and be less than 128 bytes in length. This is reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project.

properties.metadata.items[].value

string

Value for the metadata entry. These are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on values is that their size must be less than or equal to 262144 bytes (256 KiB).

properties.metadata.kind

string

[Output Only] Type of the resource. Always compute#metadata for metadata.

properties.serviceAccounts[]

object

A list of service accounts with specified scopes. Access tokens for these service accounts are available to the instances that are created from this template. Use metadata queries to obtain the access tokens for these instances.

properties.serviceAccounts[].email

string

Email address of the service account.

properties.serviceAccounts[].scopes[]

string

The list of scopes to be made available for this service account.

properties.scheduling

object

Specifies the scheduling options for the instances that are created from this template.

properties.scheduling.onHostMaintenance

enum

Defines the maintenance behavior for this instance. For standard instances, the default behavior is MIGRATE. For preemptible instances, the default and only possible behavior is TERMINATE. For more information, see Setting Instance Scheduling Options.

properties.scheduling.automaticRestart

boolean

Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted.

By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine.

properties.scheduling.preemptible

boolean

Defines whether the instance is preemptible. This can only be set during instance creation, it cannot be set or changed after the instance has been created.

properties.scheduling.nodeAffinities[]

object

A set of node affinity and anti-affinity.

properties.scheduling.nodeAffinities[].key

string

Corresponds to the label key of Node resource.

properties.scheduling.nodeAffinities[].operator

enum

Defines the operation of node selection.

properties.scheduling.nodeAffinities[].values[]

string

Corresponds to the label values of Node resource.

properties.labels

map (key: string, value: string)

Labels to apply to instances that are created from this template.

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

properties.guestAccelerators[]

object

A list of guest accelerator cards' type and count to use for instances created from the instance template.

properties.guestAccelerators[].acceleratorType

string

Full or partial URL of the accelerator type resource to attach to this instance. If you are creating an instance template, specify only the accelerator name.

properties.guestAccelerators[].acceleratorCount

number

The number of the guest accelerator cards exposed to this instance.

properties.minCpuPlatform

string

Minimum cpu/platform to be used by this instance. The instance may be scheduled on the specified or newer cpu/platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: "Intel Haswell" or minCpuPlatform: "Intel Sandy Bridge". For more information, read Specifying a Minimum CPU Platform.

sourceInstance

string

The source instance used to create the template. You can provide this as a partial or full URL to the resource. For example, the following are valid values:

sourceInstanceParams

object

The source instance params to use to create this instance template.

sourceInstanceParams.diskConfigs[]

object

Attached disks configuration. If not provided, defaults are applied: For boot disk and any other R/W disks, new custom images will be created from each disk. For read-only disks, they will be attached in read-only mode. Local SSD disks will be created as blank volumes.

sourceInstanceParams.diskConfigs[].deviceName

string

Specifies the device name of the disk to which the configurations apply to.

sourceInstanceParams.diskConfigs[].instantiateFrom

enum

Specifies whether to include the disk and what image to use. Possible values are:

  • source-image: to use the same image that was used to create the source instance's corresponding disk. Applicable to the boot disk and additional read-write disks.
  • source-image-family: to use the same image family that was used to create the source instance's corresponding disk. Applicable to the boot disk and additional read-write disks.
  • custom-image: to use a user-provided image url for disk creation. Applicable to the boot disk and additional read-write disks.
  • attach-read-only: to attach a read-only disk. Applicable to read-only disks.
  • do-not-include: to exclude a disk from the template. Applicable to additional read-write disks, local SSDs, and read-only disks.
sourceInstanceParams.diskConfigs[].autoDelete

boolean

Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).

sourceInstanceParams.diskConfigs[].customImage

string

The custom source image to be used to restore this disk when instantiating this instance template.

kind

string

[Output Only] The resource type, which is always compute#instanceTemplate for instance 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 Auth Guide.

IAM Permissions

In addition to any permissions specified on the fields above, authorization requires one or more of the following Google IAM permissions:

  • compute.instanceTemplates.get
Was this page helpful? Let us know how we did:

Send feedback about...

Compute Engine