DescribeNodeGroup-阿里云帮助中心

Queries the details of a node group.

Operation description

Queries the detailed information about a node group, including node count, machine type, image, system disk, and login configuration.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

eflo:DescribeNodeGroup

get

*Cluster

acs:eflo:{#regionId}:{#accountId}:cluster/{#ClusterId}

None

Request parameters

Parameter	Type	Required	Description	Example
NodeGroupId	string	Yes	The ID of the node group.	i128903591758597631635

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	83896080-59E3-5775-BDDC-8084691C3D96
ImageName	string	The name of the image.	Alinux3_x86_5.10.134-16.3_NV_RunC_D3_E3C7_570.133.20_V1.0_250428
NodeGroupDescription	string	The description of the node group.	lingjun alinux node group
NodeGroupName	string	The name of the node group.	test-ack
NodeCount	string	The number of nodes.	1
ClusterId	string	The ID of the cluster.	i111987311754895199538
NodeGroupId	string	The ID of the node group.	i120982301752461697971
CreateTime	string	The creation time.	2025-07-07T17:19:42.980000
MachineType	string	The instance type.	efg2.NH2cn
ImageId	string	The image ID.	i190720111752146430748
UpdateTime	string	The time when the node group was last updated.	2025-08-20T11:18:11.164000
ClusterName	string	The cluster name.	aliyun-basic-cluster
Az	string	The zone ID.	cn-wulanchabu-a
UserData	string	The user data.	#!/bin/bash uptime echo "aaaaaaa" >> /tmp/tttest.sh
SystemDisk	object	The system disk information.
Size	integer	The size of the system disk. Unit: GiB. Valid values: Basic disk: 20–500. ESSD: PL0: 1–2,048. PL1: 20–2,048. PL2: 461–2,048. PL3: 1,261–2,048. ESSD AutoPL disk: 1–2,048. Other disk categories: 20–2,048. Default value: the larger value between 20 and the size of the image that is specified by `ImageId`.	1024
PerformanceLevel	string	The performance level of the ESSD. Valid values: PL0: A single ESSD can deliver up to 10,000 random read/write IOPS. PL1: A single ESSD can deliver up to 50,000 random read/write IOPS.	PL0
Category	string	The category of the disk.	system
FileSystemMountEnabled	boolean	Indicates whether file storage can be mounted.	True
VirtualGpuEnabled	boolean	Indicates whether the node group supports GPU virtualization.	False
KeyPairName	string	The name of the key pair.	k8s-key
LoginType	string	Valid values: • password: The node group supports only password-based logon. • keypair: The node group supports only key pair-based logon. • both: The node group supports password-based and key pair-based logon. If this parameter is not returned, no logon method is configured for the node group.	password
RamRoleName	string	The name of the RAM role. You can call the ListRoles operation of the RAM API to query the RAM roles that you created.	xianwen-test-ram-role

Examples

Success response

JSON format

{
  "RequestId": "83896080-59E3-5775-BDDC-8084691C3D96",
  "ImageName": "Alinux3_x86_5.10.134-16.3_NV_RunC_D3_E3C7_570.133.20_V1.0_250428",
  "NodeGroupDescription": "lingjun alinux node group",
  "NodeGroupName": "test-ack",
  "NodeCount": "1",
  "ClusterId": "i111987311754895199538",
  "NodeGroupId": "i120982301752461697971",
  "CreateTime": "2025-07-07T17:19:42.980000",
  "MachineType": "efg2.NH2cn",
  "ImageId": "i190720111752146430748",
  "UpdateTime": "2025-08-20T11:18:11.164000",
  "ClusterName": "aliyun-basic-cluster",
  "Az": "cn-wulanchabu-a",
  "UserData": "#!/bin/bash\nuptime\necho \"aaaaaaa\" >> /tmp/tttest.sh",
  "SystemDisk": {
    "Size": 1024,
    "PerformanceLevel": "PL0",
    "Category": "system"
  },
  "FileSystemMountEnabled": true,
  "VirtualGpuEnabled": true,
  "KeyPairName": "k8s-key",
  "LoginType": "password",
  "RamRoleName": "xianwen-test-ram-role"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.