- HTTP request
- Path parameters
- Query parameters
- Request body
- Response body
- Authorization scopes
- IAM Permissions
- Try it!
Retrieves an aggregated list of node groups. Note: use nodeGroups.listNodes for more details about each group.
To prevent failure, Google recommends that you set the returnPartialSuccess
parameter to true
.
HTTP request
GET https://compute.googleapis.com/compute/beta/projects/{project}/aggregated/nodeGroups
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
project |
Project ID for this request. |
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. |
includeAllScopes |
Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. |
serviceProjectNumber |
The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api. |
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": { string: { "nodeGroups": [ { "kind": string, "id": string, "creationTimestamp": string, "name": string, "description": string, "nodeTemplate": string, "zone": string, "selfLink": string, "status": enum, "size": integer, "autoscalingPolicy": { "mode": enum, "minNodes": integer, "maxNodes": integer }, "maintenancePolicy": enum, "locationHint": string, "fingerprint": string, "maintenanceWindow": { "startTime": string, "maintenanceDuration": { "seconds": string, "nanos": integer } }, "shareSettings": { "shareType": enum, "projects": [ string ], "projectMap": { string: { "projectId": string }, ... } }, "maintenanceInterval": enum } ], "warning": { "code": enum, "message": string, "data": [ { "key": string, "value": string } ] } }, ... }, "nextPageToken": string, "selfLink": string, "warning": { "code": enum, "message": string, "data": [ { "key": string, "value": string } ] }, "unreachables": [ string ] } |
Fields | |
---|---|
kind |
[Output Only] Type of resource.Always |
id |
[Output Only] Unique identifier for the resource; defined by the server. |
items |
A list of NodeGroupsScopedList resources. Key: [Output Only] Name of the scope containing this set of node groups. |
items.nodeGroups[] |
[Output Only] A list of node groups contained in this scope. |
items.nodeGroups[].kind |
[Output Only] The type of the resource. Always |
items.nodeGroups[].id |
[Output Only] The unique identifier for the resource. This identifier is defined by the server. |
items.nodeGroups[].creationTimestamp |
[Output Only] Creation timestamp in RFC3339 text format. |
items.nodeGroups[].name |
The name of the resource, provided by the client when initially creating the resource. The resource 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.nodeGroups[].description |
An optional description of this resource. Provide this property when you create the resource. |
items.nodeGroups[].nodeTemplate |
URL of the node template to create the node group from. |
items.nodeGroups[].zone |
[Output Only] The name of the zone where the node group resides, such as us-central1-a. |
items.nodeGroups[].selfLink |
[Output Only] Server-defined URL for the resource. |
items.nodeGroups[].status |
|
items.nodeGroups[].size |
[Output Only] The total number of nodes in the node group. |
items.nodeGroups[].autoscalingPolicy |
Specifies how autoscaling should behave. |
items.nodeGroups[].autoscalingPolicy.mode |
The autoscaling mode. Set to one of: |
items.nodeGroups[].autoscalingPolicy.minNodes |
The minimum number of nodes that the group should have. |
items.nodeGroups[].autoscalingPolicy.maxNodes |
The maximum number of nodes that the group should have. Must be set if autoscaling is enabled. Maximum value allowed is 100. |
items.nodeGroups[].maintenancePolicy |
Specifies how to handle instances when a node in the group undergoes maintenance. Set to one of: |
items.nodeGroups[].locationHint |
An opaque location hint used to place the Node close to other resources. This field is for use by internal tools that use the public API. The location hint here on the NodeGroup overrides any locationHint present in the NodeTemplate. |
items.nodeGroups[].fingerprint |
A base64-encoded string. |
items.nodeGroups[].maintenanceWindow |
|
items.nodeGroups[].maintenanceWindow.startTime |
Start time of the window. This must be in UTC format that resolves to one of |
items.nodeGroups[].maintenanceWindow.maintenanceDuration |
[Output only] A predetermined duration for the window, automatically chosen to be the smallest possible in the given scenario. |
items.nodeGroups[].maintenanceWindow.maintenanceDuration.seconds |
Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years |
items.nodeGroups[].maintenanceWindow.maintenanceDuration.nanos |
Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 |
items.nodeGroups[].shareSettings |
Share-settings for the node group |
items.nodeGroups[].shareSettings.shareType |
Type of sharing for this shared-reservation |
items.nodeGroups[].shareSettings.projects[] |
A nodeGroups.list of Project names to specify consumer projects for this shared-reservation. This is only valid when shareType's value is SPECIFIC_PROJECTS. |
items.nodeGroups[].shareSettings.projectMap[] |
A map of project id and project config. This is only valid when shareType's value is SPECIFIC_PROJECTS. |
items.nodeGroups[].shareSettings.projectMap[].projectId |
The project ID, should be same as the key of this project config in the parent map. |
items.nodeGroups[].maintenanceInterval |
Specifies the frequency of planned maintenance events. The accepted values are: |
items.warning |
[Output Only] An informational warning that appears when the nodeGroup list is empty. |
items.warning.code |
[Output Only] A warning code, if applicable. For example, Compute Engine returns |
items.warning.message |
[Output Only] A human-readable description of the warning code. |
items.warning.data[] |
[Output Only] Metadata about this warning in "data": [ { "key": "scope", "value": "zones/us-east1-d" } |
items.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 |
items.warning.data[].value |
[Output Only] A warning data value corresponding to the key. |
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. |
unreachables[] |
[Output Only] Unreachable resources. |
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.list
To find predefined roles that contain those permissions, see Compute Engine IAM Roles.