node_types
Creates, updates, deletes, gets or lists a node_types resource.
Overview
| Name | node_types |
| Type | Resource |
| Id | google.compute.node_types |
Fields
The following fields are returned by SELECT queries:
- get
- list
- aggregated_list
| Name | Datatype | Description |
|---|---|---|
id | string (uint64) | [Output Only] The unique identifier for the resource. This identifier is defined by the server. |
name | string | [Output Only] Name of the resource. (pattern: a-z?) |
cpuPlatform | string | [Output Only] The CPU platform used by this node type. |
creationTimestamp | string | [Output Only] Creation timestamp in RFC3339 text format. |
deprecated | object | [Output Only] The deprecation status associated with this node type. (id: DeprecationStatus) |
description | string | [Output Only] An optional textual description of the resource. |
guestCpus | integer (int32) | [Output Only] The number of virtual CPUs that are available to the node type. |
kind | string | [Output Only] The type of the resource. Always compute#nodeType for node types. (default: compute#nodeType) |
localSsdGb | integer (int32) | [Output Only] Local SSD available to the node type, defined in GB. |
maxVms | integer (int32) | [Output Only] Maximum number of VMs that can be created for this node type. |
memoryMb | integer (int32) | [Output Only] The amount of physical memory available to the node type, defined in MB. |
selfLink | string | [Output Only] Server-defined URL for the resource. |
zone | string | [Output Only] The name of the zone where the node type resides, such as us-central1-a. |
| Name | Datatype | Description |
|---|---|---|
id | string | [Output Only] Unique identifier for the resource; defined by the server. |
items | array | A list of NodeType resources. |
kind | string | [Output Only] Type of resource.Always compute#nodeTypeList for lists of node types. (default: compute#nodeTypeList) |
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. |
| Name | Datatype | Description |
|---|---|---|
id | string (uint64) | [Output Only] The unique identifier for the resource. This identifier is defined by the server. |
name | string | [Output Only] Name of the resource. (pattern: a-z?) |
cpuPlatform | string | [Output Only] The CPU platform used by this node type. |
creationTimestamp | string | [Output Only] Creation timestamp in RFC3339 text format. |
deprecated | object | [Output Only] The deprecation status associated with this node type. (id: DeprecationStatus) |
description | string | [Output Only] An optional textual description of the resource. |
guestCpus | integer (int32) | [Output Only] The number of virtual CPUs that are available to the node type. |
kind | string | [Output Only] The type of the resource. Always compute#nodeType for node types. (default: compute#nodeType) |
localSsdGb | integer (int32) | [Output Only] Local SSD available to the node type, defined in GB. |
maxVms | integer (int32) | [Output Only] Maximum number of VMs that can be created for this node type. |
memoryMb | integer (int32) | [Output Only] The amount of physical memory available to the node type, defined in MB. |
selfLink | string | [Output Only] Server-defined URL for the resource. |
zone | string | [Output Only] The name of the zone where the node type resides, such as us-central1-a. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | project, zone, nodeType | Returns the specified node type. | |
list | select | project, zone | filter, maxResults, orderBy, pageToken, returnPartialSuccess | Retrieves a list of node types available to the specified project. |
aggregated_list | select | project | filter, includeAllScopes, maxResults, orderBy, pageToken, returnPartialSuccess, serviceProjectNumber | Retrieves an aggregated list of node types. 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.
| Name | Datatype | Description |
|---|---|---|
nodeType | string | |
project | string | |
zone | string | |
filter | string | |
includeAllScopes | boolean | |
maxResults | integer (uint32) | |
orderBy | string | |
pageToken | string | |
returnPartialSuccess | boolean | |
serviceProjectNumber | string (int64) |
SELECT examples
- get
- list
- aggregated_list
Returns the specified node type.
SELECT
id,
name,
cpuPlatform,
creationTimestamp,
deprecated,
description,
guestCpus,
kind,
localSsdGb,
maxVms,
memoryMb,
selfLink,
zone
FROM google.compute.node_types
WHERE project = '{{ project }}' -- required
AND zone = '{{ zone }}' -- required
AND nodeType = '{{ nodeType }}' -- required
;
Retrieves a list of node types available to the specified project.
SELECT
id,
items,
kind,
nextPageToken,
selfLink,
warning
FROM google.compute.node_types
WHERE project = '{{ project }}' -- required
AND zone = '{{ zone }}' -- required
AND filter = '{{ filter }}'
AND maxResults = '{{ maxResults }}'
AND orderBy = '{{ orderBy }}'
AND pageToken = '{{ pageToken }}'
AND returnPartialSuccess = '{{ returnPartialSuccess }}'
;
Retrieves an aggregated list of node types. To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.
SELECT
id,
name,
cpuPlatform,
creationTimestamp,
deprecated,
description,
guestCpus,
kind,
localSsdGb,
maxVms,
memoryMb,
selfLink,
zone
FROM google.compute.node_types
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 }}'
;