ListClusters - E-MapReduce - Alibaba Cloud Documentation Center

Queries E-MapReduce (EMR) clusters.

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 region ID. Valid values: cn-qingdao cn-beijing cn-zhangjiakou cn-huhehaote cn-hangzhou cn-shanghai cn-shenzhen cn-chengdu cn-hongkong cn-wulanchabu cn-heyuan-acdr-1 cn-qingdao-acdr-ut-1 ap-northeast-1 ap-southeast-1 ap-southeast-2 ap-southeast-3 ap-southeast-5 ap-south-1 us-east-1 us-west-1 me-east-1 me-central-1 eu-central-1 eu-west-1 cn-north-2-gov-1	cn-hangzhou
NextToken	string	No	The starting point of the current query. If you do not configure this parameter, the query starts from the beginning.	eyJlY21OZXh0VG9rZW4iOiIxIiwidGFpaGFvTmV4dFRva2VuIjoiNTYiLCJ0YWloYW9OZXh0VG9rZW5JbnQiOjU2LCJlY21OZXh0VG9rZW5JbnQiOjF9
MaxResults	integer	No	The number of entries to return on each page. Valid values: 1 to 100.	20
ClusterName	string	No	The name of the cluster.	emrtest
ResourceGroupId	string	No	The ID of the resource group.	rg-acfmzabjyop****
ClusterIds	array	No	The IDs of the clusters. You can specify a maximum of 100 items.
String	string	No	The ID of the cluster.	c-b933c5aac8fe****
ClusterTypes	array	No	The types of the clusters. You can specify a maximum of 100 items.
String	string	No	The type of a cluster. Valid values: DATALAKE: DataLake cluster in the new data lake scenario OLAP: online analytical processing cluster DATAFLOW: Dataflow cluster DATASERVING: DataServing cluster CUSTOM: custom hybrid cluster HADOOP: Hadoop cluster in the old data lake scenario	DATALAKE
ClusterStates	array	No	The states of clusters. You can specify a maximum of 100 items.
String	string	No	The state of a cluster. Valid values: STARTING: The cluster is being started. START_FAILED: The cluster fails to be started. BOOTSTRAPPING: The bootstrap action is being performed on the cluster. RUNNING: The cluster is running. TERMINATING: The cluster is being terminated. TERMINATED: The cluster is terminated. TERMINATED_WITH_ERRORS: The cluster is terminated due to an exception. TERMINATE_FAILED: The cluster fails to be terminated.	RUNNING
PaymentTypes	array	No	The billing methods. You can specify a maximum of 2 items.
PaymentType	string	No	A billing method. Valid values: PayAsYouGo: pay-as-you-go Subscription: subscription	PayAsYouGo
Tags	array	No	The tags. Number of elements in the array: 1 to 20.
Tag	Tag	No	The tag.

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
Clusters	array	The clusters.
Cluster	ClusterSummary	The cluster.
RequestId	string	The ID of the request.	9E3A7161-EB7B-172B-8D18-FFB06BA3896A
NextToken	string	The page number of the next page returned.	eyJlY21OZXh0VG9rZW4iOiIxIiwidGFpaGFvTmV4dFRva2VuIjoiNTYiLCJ0YWloYW9OZXh0VG9rZW5JbnQiOjU2LCJlY21OZXh0VG9rZW5JbnQiOjF9
MaxResults	integer	The number of entries returned per page.	20
TotalCount	integer	The total number of pages.	1000

Examples

Sample success responses

JSONformat

{
  "Clusters": [
    {
      "ClusterId": "c-b933c5aac8fe****",
      "ClusterName": "emrtest",
      "ClusterType": "DATALAKE",
      "ClusterState": "RUNNING",
      "PaymentType": "PayAsYouGo",
      "CreateTime": 1592837465784,
      "ReadyTime": 1592837465784,
      "ExpireTime": 1592837465784,
      "EndTime": 1592837465784,
      "ReleaseVersion": "EMR-5.8.0",
      "ResourceGroupId": "rg-acfmzabjyop****",
      "StateChangeReason": {
        "Code": "OutOfStock",
        "Message": "The requested resource is sold out in the specified zone, try other types of resources or other regions and zones."
      },
      "Tags": [
        {
          "Key": "department",
          "Value": "IT"
        }
      ],
      "EmrDefaultRole": "",
      "Description": ""
    }
  ],
  "RequestId": "9E3A7161-EB7B-172B-8D18-FFB06BA3896A",
  "NextToken": "eyJlY21OZXh0VG9rZW4iOiIxIiwidGFpaGFvTmV4dFRva2VuIjoiNTYiLCJ0YWloYW9OZXh0VG9rZW5JbnQiOjU2LCJlY21OZXh0VG9rZW5JbnQiOjF9",
  "MaxResults": 20,
  "TotalCount": 1000
}

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-12	The internal configuration of the API is changed, but the call is not affected	View Change Details
2023-12-07	The internal configuration of the API is changed, but the call is not affected	View Change Details
2023-10-23	The internal configuration of the API is changed, but the call is not affected	View Change Details
2023-08-09	The internal configuration of the API is changed, but the call is not affected	View Change Details
2023-08-04	The internal configuration of the API is changed, but the call is not affected	View Change Details