edit-icon download-icon

Cluster list

Last Updated: Dec 28, 2017

Query the cluster list.

Request parameters

Field Type Required? Default Value Description
StatusList Array<String> No None Select the needed cluster status for screening.
RegionId String Yes None The region Id of the cluster list.
PageNumber Integer No 1 Queried page number.
PageSize Integer No 10 Queried page size.

Returned parameters

Field Type Description
Cluster Array<ClusterInfoSimple> ClusterInfoSimple array. The ClusterInfoSimple structure can be found in the object below.
TotalCount Integer Total count.
PageNumber Integer Current page number.
PageSize Integer Currently queried page size.

ClusterInfoSimple

Field Type Description
Id String Cluster Id.
Name String Cluster name.
ChargeType String The charge type of the cluster. Billing method: Subscription or Pay-As-You-Go.
ExpiredTime Long The expiration time of the cluster, in the format of timestamp. It is similar to: 1478742700725.
Type String Cluster type, HADOOP.
CreateTime Long The creation time of the cluster, in the format of timestamp. It is similar to: 1478742700725.
RunningTime Integer The running time of the cluster. Unit: second.
Status String The cluster status.
FailReason FailReason Cluster creation failure information.
CreateType String ON-DEMAND: Creation on demand means that the cluster is created dynamically using the execution plan. MANUAL: The cluster is created manually.

Example

Request example

  1. https://emr.aliyuncs.com/?Action=ListClusters
  2. &PageSize=100
  3. &StatusList=%5B%22CREATING%22%2C+%22RUNNING%22%2C+%22IDLE%22%2C+%22RELEASING%22%2C+%22CREATE_FAILED%22%2C+%22RELEASE_FAILED%22%5D
  4. &PageNumber=1
  5. &RegionId=cn-hangzhou
  6. &Public request parameters

Returned format

JSON format

  1. {
  2. "code": "200",
  3. "data": {
  4. "Clusters": {
  5. "ClusterInfo": [
  6. {
  7. "CreateTime": 1454035046000,
  8. "FailReason": {
  9. "ErrorCode": "OperationDenied",
  10. "ErrorMsg": "The resource is out of usage.",
  11. "RequestId": "C0946CDD-25A6-45F5-8F5C-D095F12E8B6B"
  12. },
  13. "Id": "500000845",
  14. "Name": "ffff",
  15. "PayType": "PostPaid",
  16. "RunningTime": 0,
  17. "Status": "LAUNCHING_FAIL",
  18. "Type": "hadoop"
  19. },
  20. {
  21. "CreateTime": 1454034802000,
  22. "FailReason": {
  23. "ErrorCode": "OperationDenied",
  24. "ErrorMsg": "The resource is out of usage.",
  25. "RequestId": "3FCF17ED-9277-40B0-983F-52939B1B8BFF"
  26. },
  27. "Id": "500000844",
  28. "Name": "testforcerelease",
  29. "PayType": "PostPaid",
  30. "RunningTime": 0,
  31. "Status": "LAUNCHING_FAIL",
  32. "Type": "hadoop"
  33. },
  34. {
  35. "CreateTime": 1453879601000,
  36. "FailReason": {},
  37. "Id": "500000760",
  38. "Name": "New Hadoop",
  39. "PayType": "PostPaid",
  40. "RunningTime": 18938,
  41. "Status": "TERMINATED",
  42. "Type": "hadoop"
  43. },
  44. {
  45. "CreateTime": 1453877940000,
  46. "FailReason": {
  47. "ErrorCode": "MissingParameter",
  48. "ErrorMsg": "The input parameter &quot;InstanceId&quot; that is mandatory for processing this request is not supplied.",
  49. "RequestId": "D1CEBBCD-2FFD-4BBF-A7A0-87FC9378A237"
  50. },
  51. "Id": "500000759",
  52. "Name": "Cluster_OnDemandWithHourSchedual",
  53. "PayType": "PostPaid",
  54. "RunningTime": 0,
  55. "Status": "LAUNCHING_FAIL",
  56. "Type": "hadoop"
  57. },
  58. {
  59. "CreateTime": 1453877939000,
  60. "FailReason": {
  61. "ErrorCode": "MissingParameter",
  62. "ErrorMsg": "The input parameter &quot;InstanceId&quot; that is mandatory for processing this request is not supplied.",
  63. "RequestId": "F06849BF-391A-450D-AC8A-978C7DF798BF"
  64. },
  65. "Id": "500000758",
  66. "Name": "Cluster_OnDemandWithDaySchedual",
  67. "PayType": "PostPaid",
  68. "RunningTime": 0,
  69. "Status": "LAUNCHING_FAIL",
  70. "Type": "hadoop"
  71. }
  72. ]
  73. },
  74. "PageNumber": 1,
  75. "PageSize": 100,
  76. "RequestId": "C7067848-F4DC-42B4-A596-235F82E43E2E",
  77. "TotalCount": 849
  78. },
  79. "requestId": "C7067848-F4DC-42B4-A596-235F82E43E2E",
  80. "successResponse": true
  81. }
Thank you! We've received your feedback.