ListClusterHyperNodes - Platform For AI - Alibaba Cloud Documentation Center

Lists the node groups of a cluster and the nodes in each group.

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:ListClusterHyperNodes

get

*Cluster

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

None

Request parameters

Parameter	Type	Required	Description	Example
ClusterId	string	Yes	The cluster ID.	i119982311660892626523
NextToken	string	No	The token used to start the query. Set this parameter to the NextToken value returned from a previous call.	563d42ae0b17572449ec8c97f7f66069
MaxResults	integer	No	The number of entries to return on each page. The maximum value is 100. Default value: • If this parameter is not set or is set to a value less than 20, the default value is 20. • If this parameter is set to a value greater than 100, the default value is 100.	20
NodeGroupId	string	No	The node group ID.	ng-ec3c96ff0aa4c60d
Tags	array<object>	No	The tag information.
	object	No	The tag information.
Key	string	No	The tag key.	my_key
Value	string	No	The tag value.	my_value
ResourceGroupId	string	No	The resource group ID.	rg-acfmywpvugkh7kq

Response elements

Element	Type	Description	Example
	object
RequestId	string	The ID of the request.	4FD06DF0-9167-5C6F-A145-F30CA4A15D54
NextToken	string	The query token returned from this call.	563d42ae0b17572449ec8c97f7f66069
HyperNodes	array<object>	The list of nodes.
	array<object>
CreateTime	string	The time when the node was created.	2025-07-07T17:38:35.391
ExpireTime	string	The expiration time of the machine.	2025-04-19T02:32:48Z
MachineType	string	The machine type.	efg2.NH2cn
NodeGroupId	string	The node group ID.	i123229811742436895560
NodeGroupName	string	The name of the node group.	g1
HyperNodeId	string	The node ID.	e01-cn-2r42tmj4z02
ZoneId	string	The zone ID.	cn-shanghai-b
HpnZone	string	The cluster number.	B1
VpcId	string	The virtual private cloud (VPC) ID.	vpc-0jl8gs7qmx89739e210dn
VSwitchId	string	The vSwitch ID.	vsw-bp1u4ej4ap8c4yiqfi87c
Tags	array<object>	The tag information.
	object	The tag information.
Key	string	The tag key.	key1
Value	string	The tag value.	ali-zeekr-ota-doris-prod-hz-selectdb
TaskId	string	The task ID.	i153907661745288876128
CommodityCode	string	The commodity code.	bccluster_eflocomputing_public_cn
FileSystemMountEnabled	boolean	Indicates whether file storage mounting is supported.	False
Status	string	The status of the node.	Extending
Hostname	string	The hostname.	alywlcb-lingjun-gpu-0025

Examples

Success response

JSON format

{
  "RequestId": "4FD06DF0-9167-5C6F-A145-F30CA4A15D54",
  "NextToken": "563d42ae0b17572449ec8c97f7f66069",
  "HyperNodes": [
    {
      "CreateTime": "2025-07-07T17:38:35.391",
      "ExpireTime": "2025-04-19T02:32:48Z",
      "MachineType": "efg2.NH2cn",
      "NodeGroupId": "i123229811742436895560",
      "NodeGroupName": "g1",
      "HyperNodeId": "e01-cn-2r42tmj4z02",
      "ZoneId": "cn-shanghai-b",
      "HpnZone": "B1",
      "VpcId": "vpc-0jl8gs7qmx89739e210dn",
      "VSwitchId": "vsw-bp1u4ej4ap8c4yiqfi87c",
      "Tags": [
        {
          "Key": "key1",
          "Value": "ali-zeekr-ota-doris-prod-hz-selectdb"
        }
      ],
      "TaskId": "i153907661745288876128",
      "CommodityCode": "bccluster_eflocomputing_public_cn",
      "FileSystemMountEnabled": true,
      "Status": "Extending",
      "Hostname": "alywlcb-lingjun-gpu-0025"
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.