ListClusters-DataWorks(DataWorks)-阿里云帮助中心

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

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

No authorization for this operation. If you encounter issues with this operation, contact technical support.

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. Default value: 1.	1
PageSize	integer	No	The number of entries per page. Default value: 10. Maximum value: 100.	10

Response elements

Element	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.
	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

Success response

JSON format

{
  "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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.