List Managed Instances
|
|||||
|
|
Lists the instances in the managed instance group and instances that are scheduled to be created. The list includes any current actions that the group has scheduled for its instances
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 7 input parameters
Name | Format | Description |
---|---|---|
project Required |
STRING |
Project ID for this request |
region Required |
STRING |
Name of the region scoping this request |
instanceGroupManager Required |
STRING |
The name of the managed instance group |
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) |
order_by |
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 |
region STRING Required Name of the region scoping this request |
instanceGroupManager STRING Required The name of the managed instance group |
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) |
order_by 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 11 output parameters
Name | Format | Description |
---|---|---|
managedInstances[] |
OBJECT |
A Managed Instance resource |
managedInstances[].currentAction |
ENUMERATION |
[Output Only] The current action that the managed instance group has scheduled for the instance. Possible values:
|
managedInstances[].id |
INTEGER |
[Output only] The unique identifier for this resource. This field is empty when instance does not exist |
managedInstances[].instance |
STRING |
[Output Only] The URL of the instance. The URL can exist even if the instance has not yet been created |
managedInstances[].instanceStatus |
ENUMERATION |
[Output Only] The status of the instance. This field is empty when the instance does not exist |
managedInstances[].lastAttempt |
OBJECT |
|
managedInstances[].lastAttempt.errors |
OBJECT |
[Output Only] Encountered errors during the last attempt to create or delete the instance |
managedInstances[].lastAttempt.errors.errors[] |
OBJECT |
|
managedInstances[].version |
OBJECT |
|
managedInstances[].version.instanceTemplate |
STRING |
[Output Only] The intended template of the instance. This field is empty when current_action is one of { DELETING, ABANDONING } |
managedInstances[].version.name |
STRING |
[Output Only] Name of the version |
= Parameter name
= Format
managedInstances[] OBJECT A Managed Instance resource |
managedInstances[].currentAction ENUMERATION [Output Only] The current action that the managed instance group has scheduled for the instance. Possible values:
|
managedInstances[].id INTEGER [Output only] The unique identifier for this resource. This field is empty when instance does not exist |
managedInstances[].instance STRING [Output Only] The URL of the instance. The URL can exist even if the instance has not yet been created |
managedInstances[].instanceStatus ENUMERATION [Output Only] The status of the instance. This field is empty when the instance does not exist |
managedInstances[].lastAttempt OBJECT |
managedInstances[].lastAttempt.errors OBJECT [Output Only] Encountered errors during the last attempt to create or delete the instance |
managedInstances[].lastAttempt.errors.errors[] OBJECT |
managedInstances[].version OBJECT |
managedInstances[].version.instanceTemplate STRING [Output Only] The intended template of the instance. This field is empty when current_action is one of { DELETING, ABANDONING } |
managedInstances[].version.name STRING [Output Only] Name of the version |