ListClusterNodes - Platform For AI - Alibaba Cloud Documentation Center

Queries the nodes in a cluster.

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

get

*Cluster

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

None

Request parameters

Parameter	Type	Required	Description	Example
ClusterId	string	Yes	The cluster ID.	i15b480fbd2fcdbc2869cd80
NextToken	string	No	The token that is used to retrieve the next page of results. Set this parameter to the NextToken value that is returned from the last API call.	AAAAAdQ3Z+oPlg49gsr2y8jb6wY=
MaxResults	integer	No	The number of entries to return on each page. The default value is 20.	20
NodeGroupId	string	No	The node group ID.	ng-ec3c96ff0aa4c60d
Tags	array<object>	No	The tags.
	object	No	The tags.
Key	string	No	The key of the tag.	my_key
Value	string	No	The value of the tag.	my_value
ResourceGroupId	string	No	The resource group ID.	rg-ksld39333ss
OperatingStates	array	No	A list of node statuses.
	string	No	The node status.	Extending

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	2BA76272-6608-5AEC-BBA8-B6F0D3D14CDB
NextToken	string	The token to be used for the next query. If this parameter is empty, all results have been returned.	AAAAAXW/ZB9TBvH+0ZK0phtCibQgQmu1RbqplAI6Velo2OKR
Nodes	array<object>	The list of nodes.
	array<object>	The node information.
CreateTime	string	The time when the node was created.	1642472468000
ExpiredTime	string	The expiration time of the machine.	1762185600000
Hostname	string	The hostname.	72432f80-273e-11ed-b57a-acde48001122
ImageId	string	The OS image ID.	i190297201669099844192
MachineType	string	The machine type.	cn-wulanchabu-b11
NodeGroupId	string	The node group ID.	ng-e9b74f4d450cf18d
NodeGroupName	string	The node group name.	emr_master
NodeId	string	The node ID.	e01-cn-2r42tmj4z02
Sn	string	The serial number (SN) of the machine.	sn_tOuUk
ZoneId	string	The zone ID.	cn-hangzhou-b
Networks	array<object>	The network information.
	object	The network information.
BondName	string	The name of the network interface on the machine.	bond0
Ip	string	The IP address of the machine in the virtual private cloud (VPC).	192.168.22.2
SubnetId	string	The subnet ID.	subnet-fwekrvg9
VpdId	string	The VPC ID.	vpd-eoiy88ju
HpnZone	string	The cluster ID.	A1
VpcId	string	The VPC ID.	vpc-f8zcet5mwerafyqlrhyoi
VSwitchId	string	The vSwitch ID.	vsw-0jlohur7nhbxd1ttyq8p8
OperatingState	string	The status of the node. Valid values: Extending : Scaling out UnusedNodeStopped : Unused node stopped UnusedNodeStopping : Stopping unused node Unused : Unused Using : In use ReleaseLocking : Pending release Operating : Operating Cutting : Scaling in ClusterNodeStopped : Cluster node stopped UnusedNodeRecovering : Recovering unused node ClusterNodeStopping : Stopping cluster node ClusterNodeRecovering : Recovering unused node Replacing : Replacing	Extending
Tags	array<object>	The tags.
	object	The tag object.
Key	string	The tag key.	alarm_xdc
Value	string	The tag value.	true
TaskId	string	The task ID.	i-skkdsdl83ksxxs3
CommodityCode	string	The commodity code.	bccluster_eflocomputing_public_cn
ImageName	string	The image name.	Alinux3_x86_gu8xf_P_Host_D3_C7E3_550.127_Legacy_N_241230
FileSystemMountEnabled	boolean	Indicates whether file storage mounting is supported.	False
HyperNodeId	string	The hyper node ID.	e01-cn-2r42tmj4z02
NodeType	string	The node specifications.	standard

Examples

Success response

JSON format

{
  "RequestId": "2BA76272-6608-5AEC-BBA8-B6F0D3D14CDB",
  "NextToken": "AAAAAXW/ZB9TBvH+0ZK0phtCibQgQmu1RbqplAI6Velo2OKR",
  "Nodes": [
    {
      "CreateTime": "1642472468000\n",
      "ExpiredTime": "1762185600000",
      "Hostname": "72432f80-273e-11ed-b57a-acde48001122",
      "ImageId": "i190297201669099844192",
      "MachineType": "cn-wulanchabu-b11",
      "NodeGroupId": "ng-e9b74f4d450cf18d",
      "NodeGroupName": "emr_master",
      "NodeId": "e01-cn-2r42tmj4z02",
      "Sn": "sn_tOuUk",
      "ZoneId": "cn-hangzhou-b",
      "Networks": [
        {
          "BondName": "bond0",
          "Ip": "192.168.22.2",
          "SubnetId": "subnet-fwekrvg9",
          "VpdId": "vpd-eoiy88ju"
        }
      ],
      "HpnZone": "A1",
      "VpcId": "vpc-f8zcet5mwerafyqlrhyoi",
      "VSwitchId": "vsw-0jlohur7nhbxd1ttyq8p8",
      "OperatingState": "Extending",
      "Tags": [
        {
          "Key": "alarm_xdc",
          "Value": "true"
        }
      ],
      "TaskId": "i-skkdsdl83ksxxs3",
      "CommodityCode": "bccluster_eflocomputing_public_cn",
      "ImageName": "Alinux3_x86_gu8xf_P_Host_D3_C7E3_550.127_Legacy_N_241230",
      "FileSystemMountEnabled": true,
      "HyperNodeId": "e01-cn-2r42tmj4z02",
      "NodeType": "standard"
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.