ListFreeNodes - Platform For AI - Alibaba Cloud Documentation Center

Lists all unused nodes.

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

get

*Node

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

None

Request parameters

Parameter	Type	Required	Description	Example
NextToken	string	No	The query token. Set it to the NextToken value returned from the previous API call.	a3f2224a5ec7224116c4f5246120abe4
MaxResults	integer	No	The number of entries to return on each page for a paged query. The default value is 20.	20
MachineType	string	No	The machine type. 枚举值： efg1.nvga1 : efg1.nvga1 efg1.nvga1n : efg1.nvga1n efg1.nvga4 : efg1.nvga4 efg2.C48cA3sen : efg2.C48cA3sen efg2.56NHmcn : efg2.56NHmcn efg1.nvga8n : efg1.nvga8n efg2.C48cNHmcn : efg2.C48cNHmcn	mock-machine-type2
HpnZone	string	No	The cluster ID.	A1
ResourceGroupId	string	No	The resource group ID. 枚举值： rg-acfmvqmpwbwecli : rg-acfmvqmpwbwecli rg-acfm25os62qi5fq : rg-acfm25os62qi5fq rg-acfmoiyerhvhrvq : rg-acfmoiyerhvhrvq rg-acfmwaateahzoii : rg-acfmwaateahzoii rg-acfmwfm33rlt6zi : rg-acfmwfm33rlt6zi rg-acfm2zkwhkns57i : rg-acfm2zkwhkns57i	rg-acfmxno4vh5muoq
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.	129
OperatingStates	array	No	The type of unused nodes to be returned.
	string	No	The status of the nodes to return. Valid values: *: Matches all statuses. Unused: The node is not in use. Using: The node is in use. Extending: The node is being scaled out. Cutting: The node is being scaled in. Operating: An operation is in progress on the node. UnusedNodeStopping: The unused node is being stopped. UnusedNodeStopped: The unused node is stopped. UnusedNodeApprovalPendingRenew: The unused node is stopped and pending maintenance approval. UnusedNodeRepairingPendingRenew: The unused node is stopped and under maintenance. ClusterNodeStopping: The cluster node is being stopped. ClusterNodeStopped: The cluster node is stopped. ClusterNodeApprovalPendingRenew: The cluster node is stopped and pending maintenance approval. ClusterNodeRepairingPendingRenew: The cluster node is stopped and under maintenance. UnusedNodeRecovering: The unused node is being recovered. ClusterNodeRecovering: The cluster node is being recovered. ReleaseLocking: The node is pending release. Releasing: The node is being released. Diagnosing: The node is being diagnosed. Switching: The node is being switched across ASI clusters. RecoveringClusterNode: The cluster node is being recovered from maintenance. PreparationForRepairingClusterNode: The cluster node is being prepared for maintenance. RecoveringUnusedNode: The unused node is being recovered from maintenance. PreparationForRepairingUnusedNode: The unused node is being prepared for maintenance. ClusterNodeRepairing: The cluster node is under maintenance. UnusedNodeRepairing: The unused node is under maintenance. ClusterNodeRepairPendingApproval: The cluster node is pending maintenance approval. UnusedNodeRepairPendingApproval: The unused node is pending maintenance approval. Replacing: The node is being replaced.SoftwareRestoring: The software on the node is being restored. SoftwareInitializing: The software on the node is being initialized. ClusterNodeRebootPendingApproval: The cluster node is pending restart approval. ClusterNodeShuttingDown: The cluster node is being shut down. ClusterNodeShutdown: The cluster node is shut down. ClusterNodeStoppingShutdown: The shut-down cluster node is being stopped. ClusterNodeStoppedShutdown: The shut-down cluster node is stopped. ClusterNodeRepairPendingApprovalShutdown: The shut-down cluster node is pending maintenance approval. PreparationForRepairingClusterNodeShutdown: The shut-down cluster node is being prepared for maintenance. ClusterNodeRepairingShutdown: The shut-down cluster node is under maintenance. ClusterNodeApprovalPendingRenewShutdown: The shut-down cluster node is stopped and pending maintenance approval. ClusterNodeRepairingPendingRenewShutdown: The shut-down cluster node is stopped and under maintenance. ClusterNodeRebootPendingApprovalShutdown: The shut-down cluster node is pending restart approval. ClusterNodeRecoveringShutdown: The shut-down cluster node is being recovered. RecoveringClusterNodeShutdown: The shut-down cluster node is being recovered from maintenance and brought online.	Unused

Response elements

Element	Type	Description	Example
	object	Response parameters.
RequestId	string	The request ID.	AA14CB86-70C4-5CB7-9E7B-6CCA77F3512B
Nodes	array<object>	The list of nodes.
	object	The node information.
ZoneId	string	The zone ID.	cn-hangzhou-j
CreateTime	string	The creation time.	1652321554
NodeId	string	The node ID.	e01-cn-7pp2x193801
MachineType	string	The machine type.	efg1.nvga1
Sn	string	The serial number (SN) of the machine.	sn_pozkHBgicd
ExpiredTime	string	The expiration time of the machine.	1673107200
HpnZone	string	The cluster ID.	A1
ResourceGroupId	string	The resource group ID.	rg-aekzkkbrpl4owgy
OperatingState	string	The node status.	Extending
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.	alarm_xdc
Value	string	The tag value.	true
HyperNodeId	string	The hyper node ID.	e01-cn-zvp2tgykr08
NextToken	string	The token returned for the next query.	a3f2224a5ec7224116c4f5246120abe4

Examples

Success response

JSON format

{
  "RequestId": "AA14CB86-70C4-5CB7-9E7B-6CCA77F3512B",
  "Nodes": [
    {
      "ZoneId": "cn-hangzhou-j",
      "CreateTime": "1652321554",
      "NodeId": "e01-cn-7pp2x193801",
      "MachineType": "efg1.nvga1",
      "Sn": "sn_pozkHBgicd",
      "ExpiredTime": "1673107200",
      "HpnZone": "A1",
      "ResourceGroupId": "rg-aekzkkbrpl4owgy",
      "OperatingState": "Extending",
      "CommodityCode": "bccluster_eflocomputing_public_cn",
      "Tags": [
        {
          "Key": "alarm_xdc",
          "Value": "true"
        }
      ],
      "HyperNodeId": "e01-cn-zvp2tgykr08"
    }
  ],
  "NextToken": "a3f2224a5ec7224116c4f5246120abe4"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.