- HTTP request
- Path parameters
- Query parameters
- Request body
- Response body
- Authorization scopes
- IAM Permissions
- Try it!
Lists nodes in the node group.
HTTP request
POST https://compute.googleapis.com/compute/v1/projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}/listNodes
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
project |
Project ID for this request. |
zone |
The name of the zone for this request. |
nodeGroup |
Name of the NodeGroup resource whose nodes you want to list. |
Query parameters
Parameters | |
---|---|
maxResults |
The maximum number of results per page that should be returned. If the number of available results is larger than |
pageToken |
Specifies a page token to use. Set |
filter |
A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either For example, if you are filtering Compute Engine instances, you can exclude instances named The
You can also filter nested fields. For example, you could specify To filter on multiple expressions, provide each separate expression within parentheses. For example:
By default, each expression is an
If you want to use a regular expression, use the
The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use You cannot combine constraints on multiple fields using regular expressions. |
orderBy |
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 Currently, only sorting by |
returnPartialSuccess |
Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. |
Request body
The request body must be empty.
Response body
If successful, the response body contains data with the following structure:
JSON representation |
---|
{ "kind": string, "id": string, "items": [ { "name": string, "status": enum, "nodeType": string, "serverBinding": { "type": enum }, "serverId": string, "disks": [ { "diskType": string, "diskSizeGb": integer, "diskCount": integer } ], "accelerators": [ { "acceleratorType": string, "acceleratorCount": integer } ], "instances": [ string ], "instanceConsumptionData": [ { "instance": string, "consumptionInfo": { "minNodeCpus": integer, "guestCpus": integer, "memoryMb": integer, "localSsdGb": integer } } ], "consumedResources": { "minNodeCpus": integer, "guestCpus": integer, "memoryMb": integer, "localSsdGb": integer }, "totalResources": { "minNodeCpus": integer, "guestCpus": integer, "memoryMb": integer, "localSsdGb": integer }, "cpuOvercommitType": enum, "satisfiesPzs": boolean, "upcomingMaintenance": { "type": enum, "canReschedule": boolean, "windowStartTime": string, "windowEndTime": string, "latestWindowStartTime": string, "maintenanceStatus": enum } } ], "nextPageToken": string, "selfLink": string, "warning": { "code": enum, "message": string, "data": [ { "key": string, "value": string } ] } } |
Fields | |
---|---|
kind |
[Output Only] The resource type, which is always |
id |
[Output Only] Unique identifier for the resource; defined by the server. |
items[] |
A list of Node resources. |
items[].name |
The name of the node. |
items[].status |
|
items[].nodeType |
The type of this node. |
items[].serverBinding |
Binding properties for the physical server. |
items[].serverBinding.type |
|
items[].serverId |
Server ID associated with this node. |
items[].disks[] |
Local disk configurations. |
items[].disks[].diskType |
Specifies the desired disk type on the node. This disk type must be a local storage type (e.g.: |
items[].disks[].diskSizeGb |
Specifies the size of the disk in base-2 GB. |
items[].disks[].diskCount |
Specifies the number of such disks. |
items[].accelerators[] |
Accelerators for this node. |
items[].accelerators[].acceleratorType |
Full or partial URL of the accelerator type resource to attach to this instance. For example: |
items[].accelerators[].acceleratorCount |
The number of the guest accelerator cards exposed to this instance. |
items[].instances[] |
Instances scheduled on this node. |
items[].instanceConsumptionData[] |
Instance data that shows consumed resources on the node. |
items[].instanceConsumptionData[].instance |
Server-defined URL for the instance. |
items[].instanceConsumptionData[].consumptionInfo |
Resources consumed by the instance. |
items[].instanceConsumptionData[].consumptionInfo.minNodeCpus |
The minimal guaranteed number of virtual CPUs that are reserved. |
items[].instanceConsumptionData[].consumptionInfo.guestCpus |
The number of virtual CPUs that are available to the instance. |
items[].instanceConsumptionData[].consumptionInfo.memoryMb |
The amount of physical memory available to the instance, defined in MiB. |
items[].instanceConsumptionData[].consumptionInfo.localSsdGb |
The amount of local SSD storage available to the instance, defined in GiB. |
items[].consumedResources |
Node resources that are reserved by all instances. |
items[].consumedResources.minNodeCpus |
The minimal guaranteed number of virtual CPUs that are reserved. |
items[].consumedResources.guestCpus |
The number of virtual CPUs that are available to the instance. |
items[].consumedResources.memoryMb |
The amount of physical memory available to the instance, defined in MiB. |
items[].consumedResources.localSsdGb |
The amount of local SSD storage available to the instance, defined in GiB. |
items[].totalResources |
Total amount of available resources on the node. |
items[].totalResources.minNodeCpus |
The minimal guaranteed number of virtual CPUs that are reserved. |
items[].totalResources.guestCpus |
The number of virtual CPUs that are available to the instance. |
items[].totalResources.memoryMb |
The amount of physical memory available to the instance, defined in MiB. |
items[].totalResources.localSsdGb |
The amount of local SSD storage available to the instance, defined in GiB. |
items[].cpuOvercommitType |
CPU overcommit. |
items[].satisfiesPzs |
[Output Only] Reserved for future use. |
items[].upcomingMaintenance |
[Output Only] The information about an upcoming maintenance event. |
items[].upcomingMaintenance.type |
Defines the type of maintenance. |
items[].upcomingMaintenance.canReschedule |
Indicates if the maintenance can be customer triggered. |
items[].upcomingMaintenance.windowStartTime |
The current start time of the maintenance window. This timestamp value is in RFC3339 text format. |
items[].upcomingMaintenance.windowEndTime |
The time by which the maintenance disruption will be completed. This timestamp value is in RFC3339 text format. |
items[].upcomingMaintenance.latestWindowStartTime |
The latest time for the planned maintenance window to start. This timestamp value is in RFC3339 text format. |
items[].upcomingMaintenance.maintenanceStatus |
|
nextPageToken |
[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than |
selfLink |
[Output Only] Server-defined URL for this resource. |
warning |
[Output Only] Informational warning message. |
warning.code |
[Output Only] A warning code, if applicable. For example, Compute Engine returns |
warning.message |
[Output Only] A human-readable description of the warning code. |
warning.data[] |
[Output Only] Metadata about this warning in "data": [ { "key": "scope", "value": "zones/us-east1-d" } |
warning.data[].key |
[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 |
warning.data[].value |
[Output Only] A warning data value corresponding to the key. |
Authorization scopes
Requires one of the following OAuth scopes:
https://www.googleapis.com/auth/compute.readonly
https://www.googleapis.com/auth/compute
https://www.googleapis.com/auth/cloud-platform
For more information, see the Authentication Overview.
IAM Permissions
In addition to any permissions specified on the fields above, authorization requires one or more of the following IAM permissions:
compute.nodeGroups.get
To find predefined roles that contain those permissions, see Compute Engine IAM Roles.