ListHyperNodes - Platform For AI - Alibaba Cloud Documentation Center

Machines

Operation description

Queries the details of hypernodes.

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

list

*HyperNode

acs:eflo:{#regionId}:{#accountId}:hypernode/*

None

Request parameters

Parameter	Type	Required	Description	Example
NodeGroupName	string	No	The name of the node group.	emr-default
MachineType	string	No	The machine type.	efg1.nvga1
ZoneId	string	No	The ID of the zone.	cn-hangzhou-i
NextToken	string	No	The pagination token that is used in the next request to retrieve a new page of results. Set this parameter to the NextToken value that is returned from a previous call.	3a6b93229825ac667104463b56790c91
MaxResults	integer	No	The number of entries to return on each page. The maximum value is 100. Default values: • If you do not specify this parameter or you specify a value that is less than 20, the default value is 20. • If you specify a value that is greater than 100, the default value is 100.	100
ResourceGroupId	string	No	The ID of the resource group.	rg-acfmwfm33rlt6zi
HyperNodeId	string	No	The ID of the node.	e01-cn-zvp2tgykr08
ClusterName	string	No	The name of the cluster.	Standard_Cluster
HpnZone	string	No	The cluster number.	A1
Tags	array<object>	No	The tags.
	object	No	The tag.
Key	string	No	The tag key.	alarm_xdc
Value	string	No	The tag value.	129
OperatingStates	array	No	The state of the node. If you do not specify this parameter, nodes in all states are returned. Valid values: Extending, UnusedNodeStopped, UnusedNodeStopping, Unused, Using, ReleaseLocking, Operating, Cutting, ClusterNodeStopped, UnusedNodeRecovering, ClusterNodeStopping, ClusterNodeRecovering, and Replacing.
	string	No	The state of the node. If you do not specify this parameter, nodes in all states are returned. Valid values: Extending, UnusedNodeStopped, UnusedNodeStopping, Unused, Using, ReleaseLocking, Operating, Cutting, ClusterNodeStopped, UnusedNodeRecovering, ClusterNodeStopping, ClusterNodeRecovering, and Replacing.	Extending
CommodityCode	string	No	The commodity code.	rds_machineinstanceba_public_cn
HyperNodeIds	array	No	The list of node IDs.
	string	No	The list of node IDs.	e01-cn-xp54hgqx1y2z

Response elements

Element	Type	Description	Example
	object
RequestId	string	The ID of the request.	E64F9128-E2FC-5998-B769-199B0CB18138
HyperNodes	array<object>	The list of nodes.
	array<object>	The list of nodes.
ZoneId	string	The ID of the zone.	cn-hangzhou-b
ClusterName	string	The name of the cluster.	test-ack
CreateTime	string	The time when the node was created.	2025-07-09T10:41:56.577
MachineType	string	The machine type.	efg2.GN9C.cn8
HyperNodeId	string	The ID of the node.	e01-cn-2r42tmj4z02
TaskId	string	The ID of the task.	i153333771756952392398
ExpireTime	string	The expiration time.	2025-09-28T16:00:00Z
ClusterId	string	The ID of the cluster.	i115226661755786900341
NodeGroupId	string	The ID of the node group.	i121135081698451727812
NodeGroupName	string	The name of the node group.	l20c-0801
HpnZone	string	The cluster number.	A1
ResourceGroupId	string	The ID of the resource group.	rg-acfmwfm33rlt6zi
CommodityCode	string	The product code.	bccluster_eflocomputing_public_cn
Status `deprecated`	string	The status of the node.	Extending
Hostname	string	The hostname.	alywlcb-lingjun-gpu-0025
OperatingState	string	The status of the hypernode.	Using
Tags	array<object>	The list of tags.
	object	The tag.
Key	string	The key of the node tag.	alarm_xdc
Value	string	The value of the node tag.	97
NextToken	string	The token to retrieve the next page of results. If this parameter is not returned, no more results are available.	7ed93fda-5e7f-436a-ae5a-bd8e6b04e36b
MaxResults	integer	The number of entries to return on each page. The maximum value is 100. Default values: • If you do not specify this parameter or you specify a value that is less than 20, the default value is 20. • If you specify a value that is greater than 100, the default value is 100.	20

Examples

Success response

JSON format

{
  "RequestId": "E64F9128-E2FC-5998-B769-199B0CB18138",
  "HyperNodes": [
    {
      "ZoneId": "cn-hangzhou-b",
      "ClusterName": "test-ack",
      "CreateTime": "2025-07-09T10:41:56.577",
      "MachineType": "efg2.GN9C.cn8",
      "HyperNodeId": "e01-cn-2r42tmj4z02",
      "TaskId": "i153333771756952392398",
      "ExpireTime": "2025-09-28T16:00:00Z",
      "ClusterId": "i115226661755786900341",
      "NodeGroupId": "i121135081698451727812",
      "NodeGroupName": "l20c-0801",
      "HpnZone": "A1",
      "ResourceGroupId": "rg-acfmwfm33rlt6zi",
      "CommodityCode": "bccluster_eflocomputing_public_cn",
      "Status": "Extending",
      "Hostname": "alywlcb-lingjun-gpu-0025",
      "OperatingState": "Using",
      "Tags": [
        {
          "Key": "alarm_xdc",
          "Value": "97"
        }
      ]
    }
  ],
  "NextToken": "7ed93fda-5e7f-436a-ae5a-bd8e6b04e36b",
  "MaxResults": 20
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.