ListNodes - E-MapReduce - Alibaba Cloud Documentation Center

Queries the node list of an EMR cluster.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The ID of the region in which you want to create the instance.	cn-hangzhou
ClusterId	string	Yes	The ID of the cluster.	c-b933c5aac8fe****
NextToken	string	No	Marks the current position where reading starts. If you set this value to null, you can start from the beginning.	DD6B1B2A-5837-5237-ABE4-FF0C89568980
MaxResults	integer	No	The number of maximum number of records to obtain at a time. Valid values: 1 to 100.	20
NodeGroupIds	array	No	The IDs of node groups.
String	string	No	The ID of the node group.	ng-869471354ecd****
NodeIds	array	No	An array that consists of information about the ID of the node.
String	string	No	The ID of the node.	i-bp1cudc25w2bfwl5****
NodeNames	array	No	The names of the nodes.
String	string	No	The name of the node.	core1-1
PrivateIps	array	No	The private IP address.
String	string	No	The private IP address.	10.10.10.8
PublicIps	array	No	The public IP address.
String	string	No	The public IP address.	42.1.1.**
NodeStates	array	No	The status of the node.
String	string	No	The status of the node. Valid values: Pending: The instance is being created. Starting: The instance is being started. Running: The cluster is running. Stopping: The gateway is being stopped. Stopped: The instance is stopped. Terminated: The instance is terminated.	Running
Tags	array	No	The list of tags to be bound.
Tag	Tag	No	The tag that you want to add to the cloud desktop.

Response parameters

Parameter	Type	Description	Example
	object	The returned data.
Nodes	array	Details about nodes.
Node	Node	The node information.
RequestId	string	The ID of the request.	DD6B1B2A-5837-5237-ABE4-FF0C8944****
NextToken	string	The position at which the next read starts. If null is returned, the data has been read.	DD6B1B2A-5837-5237-ABE4-FF0C89568980
MaxResults	integer	The maximum number of entries returned.	20
TotalCount	integer	The total number of records in this request.	200

Examples

Sample success responses

JSONformat

{
  "Nodes": [
    {
      "ZoneId": "cn-beijing-h",
      "NodeGroupId": "ng-869471354ecd****",
      "NodeGroupType": "CORE",
      "NodeId": "i-bp1cudc25w2bfwl5****",
      "NodeName": "core1-1",
      "PublicIp": "42.120.75.***",
      "PrivateIp": "10.10.10.1",
      "InstanceType": "ecs.g6e.xlarge",
      "NodeState": "Running",
      "MaintenanceStatus": "",
      "ExpireTime": 1603728394857,
      "AutoRenew": false,
      "AutoRenewDuration": 1,
      "AutoRenewDurationUnit": "Month",
      "CreateTime": 0
    }
  ],
  "RequestId": "DD6B1B2A-5837-5237-ABE4-FF0C8944****",
  "NextToken": "DD6B1B2A-5837-5237-ABE4-FF0C89568980",
  "MaxResults": 20,
  "TotalCount": 200
}

Error codes

HTTP status code	Error code	Error message
400	ConflictParameters	Parameters that must not be used together. %s
400	IncompleteSignature	The request signature is invalid.
400	InvalidAction	The action %s requested is invalid.
400	InvalidParameter	The specified parameter %s is not valid.
400	InvalidParameterValue	The input parameter %s is invalid or out of range.
400	MissingAction	The action %s requested is missing.
400	MissingParameter	The input parameter %s that is mandatory for processing this request is not supplied.
400	NotAuthorized	You do not have permission to perform this action. %s
400	ThrottlingException	The request was denied due to request throttling. %s
404	ResourceNotFound	The resource not found by %s.
500	InternalError	The request processing has failed due to some unknown error, exception or failure.
503	ServiceFailure	The request has failed due to a temporary failure of %s service.
503	ServiceUnavailable	The request has failed due to a temporary failure of the server.

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2023-12-07	API Description Update	View Change Details
2022-10-12	The request parameters of the API has changed	View Change Details