ListFreeHyperNodes - Platform For AI - Alibaba Cloud Documentation Center

Lists the active physical servers in the rack.

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

get

*HyperNode

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

None

Request parameters

Parameter	Type	Required	Description	Example
NextToken	string	No	The token to retrieve the next page of results. Set this parameter to the NextToken value from the previous response.	a3f2224a5ec7224116c4f5246120****
MaxResults	integer	No	The number of entries to return on each page. The maximum value is 100. Default value: • If you do not set this parameter or you set a value less than 20, the default value is 20. • If you set a value greater than 100, the default value is 100.	20
MachineType	string	No	The machine type.	efg1.nvga1
HpnZone	string	No	The cluster ID.	A1
ResourceGroupId	string	No	The resource group ID.	rg-aekzyqdwnfabx6q
Tags	array<object>	No	The list of tags.
	object	No	The tag information.
Key	string	No	The tag key.	my_key
Value	string	No	The tag value.	129
Status	array	No	A list of statuses of unused nodes to return.
	string	No	The status of an unused node to return.	Unused

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	A511C02A-0127-51AA-A9F9-966382C9A1B5
HyperNodes	array<object>	The list of nodes.
	array<object>
ZoneId	string	The zone ID.	cn-wulanchabu-a
CreateTime	string	The time when the node was created.	2025-08-06T10:11:41.569
HyperNodeId	string	The node ID.	e01-cn-7pp2x193801
MachineType	string	The machine type.	efg2.ks01L20Z2
ExpireTime	string	The expiration time of the machine.	2025-01-22T23:59:59Z
HpnZone	string	The cluster ID.	A1
ResourceGroupId	string	The resource group ID.	rg-acfmwaateahzoii
CommodityCode	string	The commodity code.	bccluster_eflocomputing_public_cn
Tags	array<object>	The list of tags.
	object	The tag information.
Key	string	The tag key.	Cpu_Usage
Value	string	The tag value.	on
Status `deprecated`	string	The status of the hypernode.	Using
Hostname	string	The hostname.	alywlcb-lingjun-gpu-0025
OperatingState	string	The status of the hypernode.	Using
NextToken	string	The token to retrieve the next page of results. If this parameter is empty, no more results are available.	563d42ae0b17572449ec8c97f7f66069
MaxResults	integer	The number of entries returned on each page. The maximum value is 100. Default value: • If you do not set this parameter or you set a value less than 20, the default value is 20. • If you set a value greater than 100, the default value is 100.	20

Examples

Success response

JSON format

{
  "RequestId": "A511C02A-0127-51AA-A9F9-966382C9A1B5",
  "HyperNodes": [
    {
      "ZoneId": "cn-wulanchabu-a",
      "CreateTime": "2025-08-06T10:11:41.569",
      "HyperNodeId": "e01-cn-7pp2x193801",
      "MachineType": "efg2.ks01L20Z2",
      "ExpireTime": "2025-01-22T23:59:59Z",
      "HpnZone": "A1",
      "ResourceGroupId": "rg-acfmwaateahzoii",
      "CommodityCode": "bccluster_eflocomputing_public_cn",
      "Tags": [
        {
          "Key": "Cpu_Usage",
          "Value": "on"
        }
      ],
      "Status": "Using",
      "Hostname": "alywlcb-lingjun-gpu-0025",
      "OperatingState": "Using"
    }
  ],
  "NextToken": "563d42ae0b17572449ec8c97f7f66069",
  "MaxResults": 20
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.