ListClusters - - Alibaba Cloud Documentation Center

Queries clusters that are registered in DataWorks. E-MapReduce (EMR) clusters and Cloudera's Distribution Including Apache Hadoop (CDH) clusters are supported.

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
ClusterType	string	Yes	The type of the cluster. Valid values: CDH: CDH cluster EMR: EMR cluster	EMR
PageNumber	integer	No	The page number. Pages start from page 1.	1
PageSize	integer	No	The number of entries per page. Default value: 10. Maximum value: 100.	10

Response parameters

Parameter	Type	Description	Example
	object	The returned data.
Data	object	The returns data.
PageNumber	integer	The page number.	1
PageSize	integer	The number of entries per page.	10
TotalCount	integer	The total number of entries returned.	100
Clusters	array	List of cluster information.
Clusters	Cluster	Cluster information
RequestId	string	The request ID. You can use the request ID to query logs and troubleshoot issues.	0000-ABCD-E****
Success	boolean	Indicates whether the request was successful. Valid values: true false	true
ErrorCode	string	The error code.	101011005
ErrorMessage	string	The error message.	Invalid.Cluster.ClusterNotFound
HttpStatusCode	integer	The HTTP status code.	200

Examples

Sample success responses

JSONformat

{
  "Data": {
    "PageNumber": 1,
    "PageSize": 10,
    "TotalCount": 100,
    "Clusters": [
      {
        "ClusterId": 1234,
        "ClusterBizId": "c-d8a7523****"
      }
    ]
  },
  "RequestId": "0000-ABCD-E****",
  "Success": true,
  "ErrorCode": 101011005,
  "ErrorMessage": "Invalid.Cluster.ClusterNotFound",
  "HttpStatusCode": 200
}

Error codes

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