Aggregated List
|
|||||
|
|
||||
Retrieves an aggregated list of target 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 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 28 output parameters
| Name | Format | Description |
|---|---|---|
id |
STRING |
[Output Only] Unique identifier for the resource; defined by the server |
items |
OBJECT |
A list of TargetInstance resources |
items.customKey |
OBJECT |
Add additional named properties |
items.customKey.targetInstances[] |
OBJECT |
Represents a Target Instance resource. You can use a target instance to handle traffic for one or more forwarding rules, which is ideal for forwarding protocol traffic that is managed by a single source. For example, ESP, AH, TCP, or UDP. For more information, read Target instances. (== resource_for beta.targetInstances ==) (== resource_for v1.targetInstances ==) |
items.customKey.targetInstances[].creationTimestamp |
STRING |
[Output Only] Creation timestamp in RFC3339 text format |
items.customKey.targetInstances[].description |
STRING |
An optional description of this resource. Provide this property when you create the resource |
items.customKey.targetInstances[].id |
INTEGER |
[Output Only] The unique identifier for the resource. This identifier is defined by the server |
items.customKey.targetInstances[].instance |
STRING |
A URL to the virtual machine instance that handles traffic for this target instance. When creating a target instance, you can provide the fully-qualified URL or a valid partial URL to the desired virtual machine. For example, the following are all valid URLs:
|
items.customKey.targetInstances[].kind |
STRING |
[Output Only] The type of the resource. Always compute#targetInstance for target instances |
items.customKey.targetInstances[].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 |
items.customKey.targetInstances[].natPolicy |
ENUMERATION |
NAT option controlling how IPs are NAT'ed to the instance. Currently only NO_NAT (default value) is supported |
items.customKey.targetInstances[].selfLink |
STRING |
[Output Only] Server-defined URL for the resource |
items.customKey.targetInstances[].zone |
STRING |
[Output Only] URL of the zone where the target instance resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body |
items.customKey.warning |
OBJECT |
Informational warning which replaces the list of addresses 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 |
Type of resource |
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 TargetInstance resources |
|
items.customKey OBJECT Add additional named properties |
|
items.customKey.targetInstances[] OBJECT Represents a Target Instance resource. You can use a target instance to handle traffic for one or more forwarding rules, which is ideal for forwarding protocol traffic that is managed by a single source. For example, ESP, AH, TCP, or UDP. For more information, read Target instances. (== resource_for beta.targetInstances ==) (== resource_for v1.targetInstances ==) |
|
items.customKey.targetInstances[].creationTimestamp STRING [Output Only] Creation timestamp in RFC3339 text format |
|
items.customKey.targetInstances[].description STRING An optional description of this resource. Provide this property when you create the resource |
|
items.customKey.targetInstances[].id INTEGER [Output Only] The unique identifier for the resource. This identifier is defined by the server |
|
items.customKey.targetInstances[].instance STRING A URL to the virtual machine instance that handles traffic for this target instance. When creating a target instance, you can provide the fully-qualified URL or a valid partial URL to the desired virtual machine. For example, the following are all valid URLs:
|
|
items.customKey.targetInstances[].kind STRING [Output Only] The type of the resource. Always compute#targetInstance for target instances |
|
items.customKey.targetInstances[].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 |
|
items.customKey.targetInstances[].natPolicy ENUMERATION NAT option controlling how IPs are NAT'ed to the instance. Currently only NO_NAT (default value) is supported |
|
items.customKey.targetInstances[].selfLink STRING [Output Only] Server-defined URL for the resource |
|
items.customKey.targetInstances[].zone STRING [Output Only] URL of the zone where the target instance resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body |
|
items.customKey.warning OBJECT Informational warning which replaces the list of addresses 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 Type of resource |
|
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 |