DescribeNode-阿里云帮助中心

Queries the list of nodes.

Operation description

Queries the detailed information of a hyper node.

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

get

*Node

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

None

Request parameters

Parameter	Type	Required	Description	Example
NodeId	string	Yes	The node ID.	mock-sn-2060

Response elements

Element	Type	Description	Example
	object	Response parameters.
RequestId	string	The request ID.	AC4F0004-7BCE-52E0-891B-CAC7D64E3368
NodeGroupName	string	The node group name.	emr-default
ClusterId	string	The cluster ID.	i116913051662373010974
ClusterName	string	The cluster name.	Standard_Cluster
ZoneId	string	The zone ID.	cn-hangzhou-i
CreateTime	string	The creation time.	2022-09-30T03:35:53Z
NodeGroupId	string	The node group ID.	ng-ec3c96ff0aa4c60d
Hostname	string	The hostname.	31d38530-241e-11ed-bc63-acde48001122
ImageId	string	The image ID.	i190297201634099844192
MachineType	string	The machine type.	efg1.nvga1
NodeId	string	The node ID.	e01-cn-zvp2tgykr08
Sn	string	The unique machine identifier.	sag42ckf4jx
OperatingState	string	The node status. Valid values: Extending : Scaling out UnusedNodeStopped : Unused node stopped UnusedNodeStopping : Unused node stopping Unused : Unused Using : In use ReleaseLocking : Pending release Operating : Operating Cutting : Scaling in ClusterNodeStopped : Cluster node stopped UnusedNodeRecovering : Unused node recovering ClusterNodeStopping : Cluster node stopping ClusterNodeRecovering : Cluster node recovering Replacing : Replacing	Using
ExpiredTime	string	The expiration time.	2022-06-23T16:00:00Z
Networks	array<object>	The network information.
	object	The network information.
BondName	string	The NIC port information.	Bond0
Ip	string	The machine IP address.	47.254.235.44
SubnetId	string	The cluster subnet ID.	vsw-uf68v51fldm5egmui5a6k
VpdId	string	The cluster network ID.	vpd-xcuhjyrj
VSwitchId	string	The vSwitch ID.	vsw-asjdfklj
SecurityGroupId	string	The security group ID.	sg-bp1d3dvbh9by7j5rujax
ImageName	string	The image name.	Centos7.9_all_0811
HpnZone	string	The cluster number.	A1
ResourceGroupId	string	The resource group ID.	rg-acfmywpvugkh7kq
UserData	string	The user-defined script.	#!/bin/bash uptime echo "aaaaaaa" >> /tmp/ttttt20250110141010.sh
Disks	array<object>	The list of disk information.
	object	The disk information.
DiskId	string	The disk ID.	d-2zeap7wkns2tdmbr11se
Category	string	The disk type. Valid values: cloud_essd: ESSD cloud disk.	cloud_essd
Size	integer	The disk size. Unit: GiB.	100
PerformanceLevel	string	The performance level of the cloud disk when an ESSD cloud disk is created as a system disk. Valid values: PL0: A single disk can deliver up to 10,000 random read/write IOPS. PL1: A single disk can deliver up to 50,000 random read/write IOPS.	PL1
Type	string	The disk type. Valid values: system: system disk. data: data disk.	system
FileSystemMountEnabled	boolean	Indicates whether file system mounting is supported.	True
NodeType	string	The type of the current node. Valid values: ● cpfs-enhanced ● ebs-enhanced ● standard ● standby ● standard-v2 ● standby-v2	standard
SavingsPlanId	string	The savings plan ID.	e01-cn-zvp2tgykr08
HyperNodeId	string	The hyper node ID.	e01-cn-zvp2tgykr08

Examples

Success response

JSON format

{
  "RequestId": "AC4F0004-7BCE-52E0-891B-CAC7D64E3368",
  "NodeGroupName": "emr-default",
  "ClusterId": "i116913051662373010974",
  "ClusterName": "Standard_Cluster",
  "ZoneId": "cn-hangzhou-i",
  "CreateTime": "2022-09-30T03:35:53Z",
  "NodeGroupId": "ng-ec3c96ff0aa4c60d",
  "Hostname": "31d38530-241e-11ed-bc63-acde48001122",
  "ImageId": "i190297201634099844192",
  "MachineType": "efg1.nvga1",
  "NodeId": "e01-cn-zvp2tgykr08",
  "Sn": "sag42ckf4jx",
  "OperatingState": "Using",
  "ExpiredTime": "2022-06-23T16:00:00Z",
  "Networks": [
    {
      "BondName": "Bond0",
      "Ip": "47.254.235.44",
      "SubnetId": "vsw-uf68v51fldm5egmui5a6k",
      "VpdId": "vpd-xcuhjyrj",
      "VSwitchId": "vsw-asjdfklj",
      "SecurityGroupId": "sg-bp1d3dvbh9by7j5rujax"
    }
  ],
  "ImageName": "Centos7.9_all_0811",
  "HpnZone": "A1",
  "ResourceGroupId": "rg-acfmywpvugkh7kq",
  "UserData": "#!/bin/bash\nuptime\necho \"aaaaaaa\" >> /tmp/ttttt20250110141010.sh",
  "Disks": [
    {
      "DiskId": "d-2zeap7wkns2tdmbr11se",
      "Category": "cloud_essd",
      "Size": 100,
      "PerformanceLevel": "PL1",
      "Type": "system"
    }
  ],
  "FileSystemMountEnabled": true,
  "NodeType": "standard",
  "SavingsPlanId": "e01-cn-zvp2tgykr08",
  "HyperNodeId": "e01-cn-zvp2tgykr08"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.