You can call this operation to query the clusters by page.

Request parameters

Parameter Type Required Example Description
RegionId String Yes cn-hangzhou The region ID.
AccessKeyId String Yes LTAI8ljWyu7y**** The AccessKey ID.
ClusterTypeList.N RepeatList No ["HADOOP","KAFKA"] The list of cluster types.
CreateType String No ON-DEMAND The creation type of the cluster. Valid values: ON-DEMAND and MANUAL.
DefaultStatus Boolean No true
IsDesc Boolean No false Indicates whether to sort the clusters in descending order.
PageNumber Integer No 1 The page number. The minimum value is 1.
PageSize Integer No 10 The number of records that are displayed on each page.
StatusList.N RepeatList No ["CREATING","IDLE"] The list of status.

Response parameters

Parameter Type Example Description
RequestId String BF4FBAC6-B03E-4BFB-B6DB-EB53C34F2E22 The ID of the request.
TotalCount Integer 12 The total number of records.
PageNumber Integer 1 The page number.
PageSize Integer 10 The number of records that are displayed on each page.
Clusters The list of clusters.
Id String C-010A704DA760072A The ID of the cluster.
Name String cluster_name The name of the cluster.
Type String HADOOP The type of the cluster.
CreateTime Long 1542784048000 The creation time of the cluster.
RunningTime Integer 2345 The running duration. Unit: seconds.
Status String IDEL The status of the cluster.
ChargeType String PostPaid The billing method.
ExpiredTime Long 1542784048000 The expiration time of the subscription cluster.
Period Integer 36 The length of the subscription. Unit: months. Valid values: 1, 2, 3, 4, 5, 6, 7, 8, 9, 12, 24, and 36.
HasUncompletedOrder Boolean false Indicates whether uncompleted orders exist.
OrderList String 0 The order list.
CreateResource String ECM_EMR ECM_EMR
OrderTaskInfo A reserved parameter. The information of the order task.
TargetCount Integer 0 A reserved parameter.
CurrentCount Integer 0 A reserved parameter.
OrderIdList String 0 A reserved parameter.
FailReason The cause of creation failure.
ErrorCode String InvalidImageId.NotFound The error code.
ErrorMsg String The specified ImageId does not exist. The error message.
RequestId String B8DC3A91-3953-4444-92BB-DBC29C47EC1A The ID of the request.

Examples

  • Sample requests
    /? RegionId=cn-hangzhou
    &AccessKeyId=LTAI8ljWyu7y**** 
    &ClusterTypeList. 1=["HADOOP","KAFKA"]
    &CreateType=ON-DEMAND 
    &DefaultStatus=
    &IsDesc=false
    &PageNumber=1
    &PageSize=10 
    &StatusList. 1=["CREATING","IDLE"]
    &<Common request parameters>
  • Successful response examples
    JSON format
    {
        "clusters":[
            {
                "chargeType":"PostPaid",
                "createResource":"ECM_EMR",
                "createTime":1542784048000,
                "failReason":{},
                "hasUncompletedOrder":false,
                "id":"C-010A704DA760072A",
                "name":"jy_test_d1_test",
                "orderTaskInfo":{},
                "runningTime":3138,
                "status":"RELEASED",
                "type":"HADOOP"
            },
            {
                "chargeType":"PostPaid",
                "createResource":"ECM_EMR",
                "createTime":1538107586000,
                "failReason":{},
                "hasUncompletedOrder":false,
                "id":"C-B9712209060CAB62",
                "name":"intelligence-313-yp",
                "orderTaskInfo":{},
                "runningTime":2069400,
                "status":"RELEASED",
                "type":"HADOOP"
            },
            {
                "chargeType":"PostPaid",
                "createResource":"ECM_EMR",
                "createTime":1536546078000,
                "failReason":{},
                "hasUncompletedOrder":false,
                "id":"C-4CD9EBBD6B23C81E",
                "name":"mg-storm",
                "orderTaskInfo":{},
                "runningTime":1382155,
                "status":"RELEASED",
                "type":"HADOOP"
            },
            {
                "chargeType":"PostPaid",
                "createResource":"ECM_EMR",
                "createTime":1535363759000,
                "failReason":{},
                "hasUncompletedOrder":false,
                "id":"C-75D6EE95D722E5CA",
                "name":"df-3101-upgrade-test",
                "orderTaskInfo":{},
                "runningTime":676284,
                "status":"RELEASED",
                "type":"HADOOP"
            },
            {
                "chargeType":"PostPaid",
                "createResource":"ECM_EMR",
                "createTime":1534492361000,
                "failReason":{
                    "errorCode":"InvalidImageId.NotFound",
                    "errorMsg":"The specified ImageId does not exist.",
                    "requestId":"B8DC3A91-3953-4444-92BB-DBC29C47EC1A"
                },
                "hasUncompletedOrder":false,
                "id":"C-5EF0F3C257B16CB7",
                "name":"test cluster1",
                "orderTaskInfo":{},
                "runningTime":0,
                "status":"CREATE_FAILED",
                "type":"HADOOP"
            }
        ],
        "pageNumber":1,
        "pageSize":5,
        "requestId":"5443DB14-4641-4DFF-9226-4888EC5A2EA9",
        "totalCount":11
    }
  • Error response examples
    JSON format
    {
        "code":"RAM.Permission.NotAllow",
        "message":"It is not allow to execute this operation,please use RAM to authorize!",
        "requestId":"9AEDC439-1F63-491D-B8C6-9737C372BF3A",
        "successResponse":false
    }

Error codes

View error codes.