List

Retrieves a list of instance templates that are contained within the specified project

5 variables
49 variables

Retrieves a list of instance templates that are contained within the specified project

Authorization

To use this building block you will have to grant access to at least one of the following scopes:

  • View and manage your data across Google Cloud Platform services
  • View and manage your Google Compute Engine resources
  • View your Google Compute Engine resources

Input

This building block consumes 5 input parameters

  = Parameter name
  = Format

project STRING Required

Project ID for this request

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)

maxResults INTEGER

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)

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

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

Output

This building block provides 49 output parameters

  = Parameter name
  = Format

id STRING

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

items[] OBJECT

Represents an Instance Template resource.

You can use instance templates to create VM instances and managed instance groups. For more information, read Instance Templates. (== resource_for beta.instanceTemplates ==) (== resource_for v1.instanceTemplates ==)

items[].creationTimestamp STRING

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

items[].description STRING

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

items[].id INTEGER

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

items[].kind STRING

[Output Only] The resource type, which is always compute#instanceTemplate for instance templates

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

items[].properties OBJECT

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

items[].properties.description STRING

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

items[].properties.disks[] OBJECT

An instance-attached disk resource

items[].properties.guestAccelerators[] OBJECT

A specification of the type and number of accelerator cards attached to the instance

items[].properties.labels OBJECT

Labels to apply to instances that are created from this template

items[].properties.labels.customKey.value STRING

Labels to apply to instances that are created from this template

items[].properties.machineType STRING

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

items[].properties.metadata OBJECT

A metadata key/value entry

items[].properties.metadata.fingerprint BINARY

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, otherwise the request will fail with error 412 conditionNotMet.

To see the latest fingerprint, make a get() request to retrieve the resource

items[].properties.metadata.kind STRING

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

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

items[].properties.networkInterfaces[] OBJECT

A network interface resource attached to an instance

items[].properties.reservationAffinity OBJECT

Specifies the reservations that this instance can consume from

items[].properties.reservationAffinity.consumeReservationType ENUMERATION

Specifies the type of reservation from which this instance can consume resources: ANY_RESERVATION (default), SPECIFIC_RESERVATION, or NO_RESERVATION. See Consuming reserved instances for examples

items[].properties.reservationAffinity.key STRING

Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify googleapis.com/reservation-name as the key and specify the name of your reservation as its value

items[].properties.reservationAffinity.values[] STRING

items[].properties.scheduling OBJECT

Sets the scheduling options for an Instance. NextID: 9

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

items[].properties.scheduling.onHostMaintenance ENUMERATION

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

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

items[].properties.serviceAccounts[] OBJECT

A service account

items[].properties.shieldedInstanceConfig OBJECT

A set of Shielded Instance options

items[].properties.shieldedInstanceConfig.enableIntegrityMonitoring BOOLEAN

Defines whether the instance has integrity monitoring enabled

items[].properties.shieldedInstanceConfig.enableSecureBoot BOOLEAN

Defines whether the instance has Secure Boot enabled

items[].properties.shieldedInstanceConfig.enableVtpm BOOLEAN

Defines whether the instance has the vTPM enabled

items[].properties.tags OBJECT

A set of instance tags

items[].properties.tags.fingerprint BINARY

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

items[].properties.tags.items[] STRING

items[].selfLink STRING

[Output Only] The URL for this instance template. The server defines this URL

items[].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:

  • https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance
  • projects/project/zones/zone/instances/instance

items[].sourceInstanceParams OBJECT

A specification of the parameters to use when creating the instance template from a source instance

items[].sourceInstanceParams.diskConfigs[] OBJECT

A specification of the desired way to instantiate a disk in the instance template when its created from a source instance

kind STRING

[Output Only] The resource type, which is always compute#instanceTemplatesListResponse for instance template lists

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

selfLink STRING

[Output Only] Server-defined URL for this resource

warning OBJECT

[Output Only] Informational warning message

warning.code ENUMERATION

[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.data[] OBJECT

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

warning.message STRING

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