Aggregated List
|
|||||
|
|
||||
Retrieves the list of managed instance groups and groups them by zone
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
| Name | Format | Description |
|---|---|---|
project Required |
STRING |
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 |
= 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 37 output parameters
| Name | Format | Description |
|---|---|---|
id |
STRING |
[Output Only] Unique identifier for the resource; defined by the server |
items |
OBJECT |
A list of InstanceGroupManagersScopedList resources |
items.customKey |
OBJECT |
Add additional named properties |
items.customKey.instanceGroupManagers[] |
OBJECT |
Represents a Managed Instance Group resource. An instance group is a collection of VM instances that you can manage as a single entity. For more information, read Instance groups. For zonal Managed Instance Group, use the instanceGroupManagers resource. For regional Managed Instance Group, use the regionInstanceGroupManagers resource. (== resource_for beta.instanceGroupManagers ==) (== resource_for v1.instanceGroupManagers ==) (== resource_for beta.regionInstanceGroupManagers ==) (== resource_for v1.regionInstanceGroupManagers ==) |
items.customKey.instanceGroupManagers[].baseInstanceName |
STRING |
The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035 |
items.customKey.instanceGroupManagers[].creationTimestamp |
STRING |
[Output Only] The creation timestamp for this managed instance group in RFC3339 text format |
items.customKey.instanceGroupManagers[].currentActions |
OBJECT |
|
items.customKey.instanceGroupManagers[].description |
STRING |
An optional description of this resource. Provide this property when you create the resource |
items.customKey.instanceGroupManagers[].distributionPolicy |
OBJECT |
|
items.customKey.instanceGroupManagers[].fingerprint |
BINARY |
Fingerprint of this resource. This field may be used in optimistic locking. It will be ignored when inserting an InstanceGroupManager. An up-to-date fingerprint must be provided in order to update the InstanceGroupManager, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an InstanceGroupManager |
items.customKey.instanceGroupManagers[].id |
INTEGER |
[Output Only] A unique identifier for this resource type. The server generates this identifier |
items.customKey.instanceGroupManagers[].instanceGroup |
STRING |
[Output Only] The URL of the Instance Group resource |
items.customKey.instanceGroupManagers[].instanceTemplate |
STRING |
The URL of the instance template that is specified for this managed instance group. The group uses this template to create all new instances in the managed instance group |
items.customKey.instanceGroupManagers[].kind |
STRING |
[Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups |
items.customKey.instanceGroupManagers[].name |
STRING |
The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035 |
items.customKey.instanceGroupManagers[].region |
STRING |
[Output Only] The URL of the region where the managed instance group resides (for regional resources) |
items.customKey.instanceGroupManagers[].selfLink |
STRING |
[Output Only] The URL for this managed instance group. The server defines this URL |
items.customKey.instanceGroupManagers[].status |
OBJECT |
|
items.customKey.instanceGroupManagers[].targetPools[] |
STRING |
|
items.customKey.instanceGroupManagers[].targetSize |
INTEGER |
The target number of running instances for this managed instance group. Deleting or abandoning instances reduces this number. Resizing the group changes this number |
items.customKey.instanceGroupManagers[].updatePolicy |
OBJECT |
|
items.customKey.instanceGroupManagers[].zone |
STRING |
[Output Only] The URL of the zone where the managed instance group is located (for zonal resources) |
items.customKey.warning |
OBJECT |
[Output Only] The warning that replaces the list of managed instance groups when the list is empty |
items.customKey.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 |
items.customKey.warning.data[] |
OBJECT |
|
items.customKey.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) |
items.customKey.warning.data[].value |
STRING |
[Output Only] A warning data value corresponding to the key |
items.customKey.warning.message |
STRING |
[Output Only] A human-readable description of the warning code |
kind |
STRING |
[Output Only] The resource type, which is always compute#instanceGroupManagerAggregatedList for an aggregated list of managed instance groups |
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 |
= Parameter name
= Format
|
id STRING [Output Only] Unique identifier for the resource; defined by the server |
|
items OBJECT A list of InstanceGroupManagersScopedList resources |
|
items.customKey OBJECT Add additional named properties |
|
items.customKey.instanceGroupManagers[] OBJECT Represents a Managed Instance Group resource. An instance group is a collection of VM instances that you can manage as a single entity. For more information, read Instance groups. For zonal Managed Instance Group, use the instanceGroupManagers resource. For regional Managed Instance Group, use the regionInstanceGroupManagers resource. (== resource_for beta.instanceGroupManagers ==) (== resource_for v1.instanceGroupManagers ==) (== resource_for beta.regionInstanceGroupManagers ==) (== resource_for v1.regionInstanceGroupManagers ==) |
|
items.customKey.instanceGroupManagers[].baseInstanceName STRING The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035 |
|
items.customKey.instanceGroupManagers[].creationTimestamp STRING [Output Only] The creation timestamp for this managed instance group in RFC3339 text format |
|
items.customKey.instanceGroupManagers[].currentActions OBJECT |
|
items.customKey.instanceGroupManagers[].description STRING An optional description of this resource. Provide this property when you create the resource |
|
items.customKey.instanceGroupManagers[].distributionPolicy OBJECT |
|
items.customKey.instanceGroupManagers[].fingerprint BINARY Fingerprint of this resource. This field may be used in optimistic locking. It will be ignored when inserting an InstanceGroupManager. An up-to-date fingerprint must be provided in order to update the InstanceGroupManager, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an InstanceGroupManager |
|
items.customKey.instanceGroupManagers[].id INTEGER [Output Only] A unique identifier for this resource type. The server generates this identifier |
|
items.customKey.instanceGroupManagers[].instanceGroup STRING [Output Only] The URL of the Instance Group resource |
|
items.customKey.instanceGroupManagers[].instanceTemplate STRING The URL of the instance template that is specified for this managed instance group. The group uses this template to create all new instances in the managed instance group |
|
items.customKey.instanceGroupManagers[].kind STRING [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups |
|
items.customKey.instanceGroupManagers[].name STRING The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035 |
|
items.customKey.instanceGroupManagers[].region STRING [Output Only] The URL of the region where the managed instance group resides (for regional resources) |
|
items.customKey.instanceGroupManagers[].selfLink STRING [Output Only] The URL for this managed instance group. The server defines this URL |
|
items.customKey.instanceGroupManagers[].status OBJECT |
|
items.customKey.instanceGroupManagers[].targetPools[] STRING |
|
items.customKey.instanceGroupManagers[].targetSize INTEGER The target number of running instances for this managed instance group. Deleting or abandoning instances reduces this number. Resizing the group changes this number |
|
items.customKey.instanceGroupManagers[].updatePolicy OBJECT |
|
items.customKey.instanceGroupManagers[].zone STRING [Output Only] The URL of the zone where the managed instance group is located (for zonal resources) |
|
items.customKey.warning OBJECT [Output Only] The warning that replaces the list of managed instance groups when the list is empty |
|
items.customKey.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 |
|
items.customKey.warning.data[] OBJECT |
|
items.customKey.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) |
|
items.customKey.warning.data[].value STRING [Output Only] A warning data value corresponding to the key |
|
items.customKey.warning.message STRING [Output Only] A human-readable description of the warning code |
|
kind STRING [Output Only] The resource type, which is always compute#instanceGroupManagerAggregatedList for an aggregated list of managed instance groups |
|
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 |