Skip to main content

instance_templates_aggregated

Creates, updates, deletes, gets or lists an instance_templates_aggregated resource.

Overview

Nameinstance_templates_aggregated
TypeResource
Idgoogle.compute.instance_templates_aggregated

Fields

The following fields are returned by SELECT queries:

Successful response

NameDatatypeDescription
idstring (uint64)[Output Only] A unique identifier for this instance template. The server defines this identifier.
namestringName 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. (pattern: a-z?)
creationTimestampstring[Output Only] The creation timestamp for this instance template in RFC3339 text format.
descriptionstringAn optional description of this resource. Provide this property when you create the resource.
kindstring[Output Only] The resource type, which is always compute#instanceTemplate for instance templates. (default: compute#instanceTemplate)
propertiesobjectThe instance properties for this instance template. (id: InstanceProperties)
regionstring[Output Only] URL of the region where the instance template resides. Only applicable for regional resources.
selfLinkstring[Output Only] The URL for this instance template. The server defines this URL.
sourceInstancestringThe 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
sourceInstanceParamsobjectThe source instance params to use to create this instance template. (id: SourceInstanceParams)

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
aggregated_listselectprojectfilter, includeAllScopes, maxResults, orderBy, pageToken, returnPartialSuccess, serviceProjectNumberRetrieves the list of all InstanceTemplates resources, regional and global, available to the specified project. To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
projectstring
filterstring
includeAllScopesboolean
maxResultsinteger (uint32)
orderBystring
pageTokenstring
returnPartialSuccessboolean
serviceProjectNumberstring (int64)

SELECT examples

Retrieves the list of all InstanceTemplates resources, regional and global, available to the specified project. To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.

SELECT
id,
name,
creationTimestamp,
description,
kind,
properties,
region,
selfLink,
sourceInstance,
sourceInstanceParams
FROM google.compute.instance_templates_aggregated
WHERE project = '{{ project }}' -- required
AND filter = '{{ filter }}'
AND includeAllScopes = '{{ includeAllScopes }}'
AND maxResults = '{{ maxResults }}'
AND orderBy = '{{ orderBy }}'
AND pageToken = '{{ pageToken }}'
AND returnPartialSuccess = '{{ returnPartialSuccess }}'
AND serviceProjectNumber = '{{ serviceProjectNumber }}';