Stay organized with collections Save and categorize content based on your preferences.
Returns the specified NodeGroup. nodeGroups.get a list of available NodeGroups by making a list()
request. Note: the "nodes" field should not be used. Use nodeGroups.listNodes instead.
GET https://compute.googleapis.com/compute/v1/projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}
The URL uses gRPC Transcoding syntax.
Path parameters Parametersproject
string
Project ID for this request.
zone
string
The name of the zone for this request.
nodeGroup
string
Name of the node group to return.
Request bodyThe request body must be empty.
Response bodyRepresents a sole-tenant Node Group resource.
A sole-tenant node is a physical server that is dedicated to hosting VM instances only for your specific project. Use sole-tenant nodes to keep your instances physically separated from instances in other projects, or to group your instances together on the same host hardware. For more information, read Sole-tenant nodes.
If successful, the response body contains data with the following structure:
JSON representation{ "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, "projectMap": { string: { "projectId": string }, ... } }, "maintenanceInterval": enum }Fields
kind
string
[Output Only] The type of the resource. Always compute#nodeGroup
for node group.
id
string (uint64 format)
[Output Only] The unique identifier for the resource. This identifier is defined by the server.
creationTimestamp
string
[Output Only] Creation timestamp in RFC3339 text format.
name
string
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 [a-z]([-a-z0-9]*[a-z0-9])?
which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
description
string
An optional description of this resource. Provide this property when you create the resource.
nodeTemplate
string
URL of the node template to create the node group from.
zone
string
[Output Only] The name of the zone where the node group resides, such as us-central1-a.
selfLink
string
[Output Only] Server-defined URL for the resource.
status
enum
size
integer
[Output Only] The total number of nodes in the node group.
autoscalingPolicy
object
Specifies how autoscaling should behave.
autoscalingPolicy.mode
enum
The autoscaling mode. Set to one of: ON
, OFF
, or ONLY_SCALE_OUT
. For more information, see Autoscaler modes.
autoscalingPolicy.minNodes
integer
The minimum number of nodes that the group should have.
autoscalingPolicy.maxNodes
integer
The maximum number of nodes that the group should have. Must be set if autoscaling is enabled. Maximum value allowed is 100.
maintenancePolicy
enum
Specifies how to handle instances when a node in the group undergoes maintenance. Set to one of: DEFAULT
, RESTART_IN_PLACE
, or MIGRATE_WITHIN_NODE_GROUP
. The default value is DEFAULT
. For more information, see Maintenance policies.
locationHint
string
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.
fingerprint
string (bytes format)
A base64-encoded string.
maintenanceWindow
object
maintenanceWindow.startTime
string
Start time of the window. This must be in UTC format that resolves to one of 00:00
, 04:00
, 08:00
, 12:00
, 16:00
, or 20:00
. For example, both 13:00-5
and 08:00
are valid.
maintenanceWindow.maintenanceDuration
object
[Output only] A predetermined duration for the window, automatically chosen to be the smallest possible in the given scenario.
maintenanceWindow.maintenanceDuration.seconds
string (int64 format)
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
maintenanceWindow.maintenanceDuration.nanos
integer
Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 seconds
field and a positive nanos
field. Must be from 0 to 999,999,999 inclusive.
shareSettings.shareType
enum
Type of sharing for this shared-reservation
shareSettings.projectMap[]
map (key: string, value: object)
A map of project id and project config. This is only valid when shareType's value is SPECIFIC_PROJECTS.
shareSettings.projectMap[].projectId
string
The project ID, should be same as the key of this project config in the parent map.
maintenanceInterval
enum
Specifies the frequency of planned maintenance events. The accepted values are: AS_NEEDED
and RECURRENT
.
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 PermissionsIn 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.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-07-28 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-07-28 UTC."],[[["This documentation outlines how to retrieve details about a specific NodeGroup using a `GET` request to the Google Compute Engine API."],["The `GET` request requires the project ID, zone, and node group name as path parameters in the URL, and the request body must be empty."],["The response body provides detailed information about the NodeGroup, including its kind, ID, creation timestamp, name, description, node template, zone, status, size, and various policy settings like autoscaling and maintenance."],["Authorization to perform this operation requires specific OAuth scopes or IAM permissions, such as `compute.nodeGroups.get`."],["The NodeGroup represents a sole-tenant Node Group resource, a dedicated physical server that only hosts VM instances for a specific project, in addition to the specified maintenance windows."]]],[]]
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4