Use ListClusters to list clusters - E-MapReduce - Alibaba Cloud - E-MapReduce

Queries a list of EMR clusters.

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

emr:ListClusters

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID.	cn-hangzhou
NextToken	string	No	The token that specifies the position from which to start reading. If this parameter is left empty, the query starts from the beginning.	eyJlY21OZXh0VG9rZW4iOiIxIiwidGFpaGFvTmV4dFRva2VuIjoiNTYiLCJ0YWloYW9OZXh0VG9rZW5JbnQiOjU2LCJlY21OZXh0VG9rZW5JbnQiOjF9
MaxResults	integer	No	The maximum number of records to return in a single request. 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 list of cluster IDs. The number of array elements N ranges from 1 to 100.	rg-acfmzabjyop****
	string	No	The ID of the cluster.	c-b933c5aac8fe****
ClusterTypes	array	No	The list of cluster types. The number of array elements N ranges from 1 to 100.	["c-b933c5aac8fe****"]
	string	No	The type of the cluster. Valid values: DATALAKE: new data lake OLAP: data analytics DATAFLOW: real-time data streaming DATASERVING: data service CUSTOM: custom colocation cluster HADOOP: legacy data lake	DATALAKE
ClusterStates	array	No	The array of cluster states. The number of array elements N ranges from 1 to 100.	["HADOOP"]
	string	No	The state of the cluster. Valid values: STARTING: starting START_FAILED: start failed BOOTSTRAPPING: bootstrapping RUNNING: running TERMINATING: terminating TERMINATED: terminated TERMINATED_WITH_ERRORS: terminated with errors TERMINATE_FAILED: termination failed	RUNNING
PaymentTypes	array	No	The payment types. Valid values of N: 1 to 2.	["ECS"]
	string	No	The payment type. Valid values: PayAsYouGo: pay-as-you-go Subscription: subscription	PayAsYouGo
Tags	array	No	The list of labels. The number of array elements N ranges from 1 to 20.	["PayAsYouGo"]
	Tag	No	The tag.

Response elements

Element	Type	Description	Example
	object	The response data.
Clusters	array	The list of clusters.
	ClusterSummary	The cluster information.
MaxResults	integer	The page size.	20
NextToken	string	The token for the next page.	eyJlY21OZXh0VG9rZW4iOiIxIiwidGFpaGFvTmV4dFRva2VuIjoiNTYiLCJ0YWloYW9OZXh0VG9rZW5JbnQiOjU2LCJlY21OZXh0VG9rZW5JbnQiOjF9
RequestId	string	The request ID.	9E3A7161-EB7B-172B-8D18-FFB06BA3896A
TotalCount	integer	The total number of entries.	1000

Examples

Success response

JSON format

{
  "Clusters": [
    {
      "ClusterId": "c-b933c5aac8fe****",
      "ClusterName": "emrtest",
      "ClusterState": "RUNNING",
      "ClusterType": "DATALAKE",
      "CreateTime": 1592837465788,
      "DeletionProtection": false,
      "Description": "EMR cluster",
      "EmrDefaultRole": "AliyunEMRDefaultRole",
      "EndTime": 1592837485788,
      "ExpireTime": 1592837475788,
      "PaymentType": "PayAsYouGo",
      "ReadyTime": 1592837465788,
      "ReleaseVersion": "EMR-5.8.0",
      "ResourceGroupId": "rg-acfmzabjyop****",
      "StateChangeReason": {
        "Message": "The requested resource is sold out in the specified zone, try other types of resources or other regions and zones.",
        "Code": "OutOfStock"
      },
      "Tags": [
        {
          "Value": "IT",
          "Key": "department"
        }
      ]
    }
  ],
  "MaxResults": 20,
  "NextToken": "eyJlY21OZXh0VG9rZW4iOiIxIiwidGFpaGFvTmV4dFRva2VuIjoiNTYiLCJ0YWloYW9OZXh0VG9rZW5JbnQiOjU2LCJlY21OZXh0VG9rZW5JbnQiOjF9",
  "RequestId": "9E3A7161-EB7B-172B-8D18-FFB06BA3896A",
  "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
500	InternalError	The request processing has failed due to some unknown error, exception or failure.
404	ResourceNotFound	The resource not found by %s.
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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.