All Products
Search
Document Center

E-MapReduce:ListNodes

Last Updated:Dec 12, 2024

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.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
emr:ListNodeslist
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The ID of the region in which you want to create the instance.

cn-hangzhou
ClusterIdstringYes

The ID of the cluster.

c-b933c5aac8fe****
NextTokenstringNo

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
MaxResultsintegerNo

The number of maximum number of records to obtain at a time. Valid values: 1 to 100.

20
NodeGroupIdsarrayNo

The IDs of node groups.

StringstringNo

The ID of the node group.

ng-869471354ecd****
NodeIdsarrayNo

An array that consists of information about the ID of the node.

StringstringNo

The ID of the node.

i-bp1cudc25w2bfwl5****
NodeNamesarrayNo

The names of the nodes.

StringstringNo

The name of the node.

core1-1
PrivateIpsarrayNo

The private IP address.

StringstringNo

The private IP address.

10.10.10.8
PublicIpsarrayNo

The public IP address.

StringstringNo

The public IP address.

42.1.1.**
NodeStatesarrayNo

The status of the node.

StringstringNo

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
TagsarrayNo

The list of tags to be bound.

TagTagNo

The tag that you want to add to the cloud desktop.

Response parameters

ParameterTypeDescriptionExample
object

The returned data.

Nodesarray

Details about nodes.

NodeNode

The node information.

RequestIdstring

The ID of the request.

DD6B1B2A-5837-5237-ABE4-FF0C8944****
NextTokenstring

The position at which the next read starts. If null is returned, the data has been read.

DD6B1B2A-5837-5237-ABE4-FF0C89568980
MaxResultsinteger

The maximum number of entries returned.

20
TotalCountinteger

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.1.1.**",
      "PrivateIp": "10.10.**.**",
      "InstanceType": "ecs.g7.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 codeError codeError message
400ConflictParametersParameters that must not be used together. %s
400IncompleteSignatureThe request signature is invalid.
400InvalidActionThe action %s requested is invalid.
400InvalidParameterThe specified parameter %s is not valid.
400InvalidParameterValueThe input parameter %s is invalid or out of range.
400MissingActionThe action %s requested is missing.
400MissingParameterThe input parameter %s that is mandatory for processing this request is not supplied.
400NotAuthorizedYou do not have permission to perform this action. %s
400ThrottlingExceptionThe request was denied due to request throttling. %s
404ResourceNotFoundThe resource not found by %s.
500InternalErrorThe request processing has failed due to some unknown error, exception or failure.
503ServiceFailureThe request has failed due to a temporary failure of %s service.
503ServiceUnavailableThe 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 timeSummary of changesOperation
2023-12-07API Description UpdateView Change Details
2022-10-12The request parameters of the API has changedView Change Details