Aggregated List
|
|||||
|
|
||||
Retrieves an aggregated list of node types
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 31 output parameters
| Name | Format | Description |
|---|---|---|
id |
STRING |
[Output Only] Unique identifier for the resource; defined by the server |
items |
OBJECT |
A list of NodeTypesScopedList resources |
items.customKey |
OBJECT |
Add additional named properties |
items.customKey.nodeTypes[] |
OBJECT |
Represent a sole-tenant Node Type resource. Each node within a node group must have a node type. A node type specifies the total amount of cores and memory for that node. Currently, the only available node type is n1-node-96-624 node type that has 96 vCPUs and 624 GB of memory, available in multiple zones. For more information read Node types. (== resource_for beta.nodeTypes ==) (== resource_for v1.nodeTypes ==) |
items.customKey.nodeTypes[].cpuPlatform |
STRING |
[Output Only] The CPU platform used by this node type |
items.customKey.nodeTypes[].creationTimestamp |
STRING |
[Output Only] Creation timestamp in RFC3339 text format |
items.customKey.nodeTypes[].deprecated |
OBJECT |
Deprecation status for a public resource |
items.customKey.nodeTypes[].description |
STRING |
[Output Only] An optional textual description of the resource |
items.customKey.nodeTypes[].guestCpus |
INTEGER |
[Output Only] The number of virtual CPUs that are available to the node type |
items.customKey.nodeTypes[].id |
INTEGER |
[Output Only] The unique identifier for the resource. This identifier is defined by the server |
items.customKey.nodeTypes[].kind |
STRING |
[Output Only] The type of the resource. Always compute#nodeType for node types |
items.customKey.nodeTypes[].localSsdGb |
INTEGER |
[Output Only] Local SSD available to the node type, defined in GB |
items.customKey.nodeTypes[].memoryMb |
INTEGER |
[Output Only] The amount of physical memory available to the node type, defined in MB |
items.customKey.nodeTypes[].name |
STRING |
[Output Only] Name of the resource |
items.customKey.nodeTypes[].selfLink |
STRING |
[Output Only] Server-defined URL for the resource |
items.customKey.nodeTypes[].zone |
STRING |
[Output Only] The name of the zone where the node type resides, such as us-central1-a |
items.customKey.warning |
OBJECT |
[Output Only] An informational warning that appears when the node types 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] Type of resource.Always compute#nodeTypeAggregatedList for aggregated lists of node types |
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 NodeTypesScopedList resources |
|
items.customKey OBJECT Add additional named properties |
|
items.customKey.nodeTypes[] OBJECT Represent a sole-tenant Node Type resource. Each node within a node group must have a node type. A node type specifies the total amount of cores and memory for that node. Currently, the only available node type is n1-node-96-624 node type that has 96 vCPUs and 624 GB of memory, available in multiple zones. For more information read Node types. (== resource_for beta.nodeTypes ==) (== resource_for v1.nodeTypes ==) |
|
items.customKey.nodeTypes[].cpuPlatform STRING [Output Only] The CPU platform used by this node type |
|
items.customKey.nodeTypes[].creationTimestamp STRING [Output Only] Creation timestamp in RFC3339 text format |
|
items.customKey.nodeTypes[].deprecated OBJECT Deprecation status for a public resource |
|
items.customKey.nodeTypes[].description STRING [Output Only] An optional textual description of the resource |
|
items.customKey.nodeTypes[].guestCpus INTEGER [Output Only] The number of virtual CPUs that are available to the node type |
|
items.customKey.nodeTypes[].id INTEGER [Output Only] The unique identifier for the resource. This identifier is defined by the server |
|
items.customKey.nodeTypes[].kind STRING [Output Only] The type of the resource. Always compute#nodeType for node types |
|
items.customKey.nodeTypes[].localSsdGb INTEGER [Output Only] Local SSD available to the node type, defined in GB |
|
items.customKey.nodeTypes[].memoryMb INTEGER [Output Only] The amount of physical memory available to the node type, defined in MB |
|
items.customKey.nodeTypes[].name STRING [Output Only] Name of the resource |
|
items.customKey.nodeTypes[].selfLink STRING [Output Only] Server-defined URL for the resource |
|
items.customKey.nodeTypes[].zone STRING [Output Only] The name of the zone where the node type resides, such as us-central1-a |
|
items.customKey.warning OBJECT [Output Only] An informational warning that appears when the node types 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] Type of resource.Always compute#nodeTypeAggregatedList for aggregated lists of node types |
|
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 |