调用ListClusters接口,查询每个地域所有集群的列表。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String ListClusters

系统规定参数。取值:ListClusters。

RegionId String cn-hangzhou

地域ID。您可以调用DescribeRegions接口查看最新的阿里云地域列表。

ClusterTypeList.N RepeatList ["HADOOP","KAFKA"]

集群类型,取值如下:

  • HADOOP
  • KAFKA
  • DATA SCIENCE
  • DRUID
  • FLINK
  • GATEWAY
  • CLICKHOSUE
  • ZOOKPEER
CreateType String ON-DEMAND

集群的创建方式,取值如下:

  • ON-DEMAND:按需创建
  • MANUAL:手动创建
MachineType String ECS

机器类型。默认是ECS。

StatusList.N RepeatList ["CREATING","IDLE"]

集群状态,取值如下:

  • CREATING:集群创建中
  • CREATE_FAILED:集群创建失败
  • RUNNING:运行中
  • IDLE:集群空闲
  • RELEASING:集群释放中
  • RELEASE_FAILED:集群释放失败
  • RELEASED:集群已释放
  • WAIT_FOR_PAY:待支付
  • ABNORMAL:集群状态异常
IsDesc Boolean false

是否倒序排列:

  • true:倒序排列
  • false:非倒序排列
DepositType String HALF_MANAGED

托管类型,取值如下:

  • HALF_MANAGED:半托管
  • MANAGED:全托管
PageNumber Integer 1

当前页码,从1开始。

PageSize Integer 10

分页查询时设置的每页行数。

DefaultStatus Boolean true

是否查询默认状态为初始化中、等待构建、空闲、运行中、释放中或创建失败的集群。取值如下:

  • false:是
  • true:否
Name String cluster_name

集群名称。

VpcId String vpc-bp1c85tzgqu1bf5b****

实例绑定的VPC ID。

ResourceGroupId String rg-bp67acfmxazb4p****

资源组ID。您可以调用ListResourceGroups查看资源组ID。

Tag.N.Key String TestKey

EMR实例和节点ECS实例的标签键。N的取值范围:1~20。一旦传入该值,则不允许为空字符串。标签键取值:1~128,不能以aliyun和acs:开头,不能包含http://或者https://。

Tag.N.Value String TestValue

EMR实例和节点ECS实例的标签值。N的取值范围:1~20。一旦传入该值,可以为空字符串。标签值的取值范围1~128,不能以acs:开头,不能包含http://或者https://。

ExpiredTagList.N RepeatList 0

保留字段。

返回数据

名称 类型 示例值 描述
Clusters Array of ClusterInfo

集群列表。

ClusterInfo
ChargeType String PostPaid

付费类型,取值如下:

  • PostPaid:按量付费集群
  • PrePaid:包年包月集群
CreateResource String ECM_EMR

自动附加到EMR集群的标签。

CreateTime Long 1542784048000

创建时间。

DepositType String HALF_MANAGED

托管类型,取值如下:

  • HALF_MANAGED:半托管
  • MANAGED:全托管
ExpiredTime Long 1542784048000

包年包月集群超时时间。

说明 按量付费集群不体现该参数。
FailReason Struct

创建失败原因。

ErrorCode String InvalidImageId.NotFound

错误码。

ErrorMsg String The specified ImageId does not exist.

错误信息。

RequestId String B8DC3A91-3953-4444-92BB-DBC29C47EC1A

请求ID。

HasUncompletedOrder Boolean false

是否有未完成的订单:

  • true:有未完成的订单
  • false:没有未完成的订单
Id String C-010A704DA760****

集群ID。

K8sClusterId String

保留字段。

MachineType String ECS

集群的主机类型,目前默认为ECS。

MetaStoreType String LOCAL

元数据类型,取值如下:

  • LOCAL:集群内部元数据
  • UNIFIED:统一元数据
  • USER_RDS:用户自建RDS
Name String cluster_name

集群名。

OperationId Long 1111

操作ID。

OrderList String 0

订单列表。

OrderTaskInfo Struct

保留字段,订单任务信息。

CurrentCount Integer 0

保留字段。

OrderIdList String 0

保留字段。

TargetCount Integer 0

保留字段。

Period Integer 36

包年包月时间(可选包月数量有:1、2、3、4、5、6、7、8、9、12、24、36。)

RunningTime Integer 2345

已运行时间。单位:秒。

Status String IDEL

集群状态。

Tags Array of Tag

标签列表。

Tag
TagKey String DevDept

资源的标签键。N的取值范围:1~20。一旦传入该值,则不允许为空字符串。标签键的取值范围1~128,不能以aliyun或acs:开头,不能包含http://或者https://。

TagValue String DevNianmin

资源的标签值。N的取值范围:1~20。一旦传入该值,可以为空字符串。标签值的取值范围1~128,不能以acs:开头,不能包含http://或者https://。

Type String HADOOP

集群类型。

PageNumber Integer 1

当前页码。

PageSize Integer 10

分页查询时设置的每页行数。

RequestId String BF4FBAC6-B03E-4BFB-B6DB-EB53C34F2E22

请求ID。

TotalCount Integer 12

查询总数。

示例

请求示例

http(s)://[Endpoint]/?Action=ListClusters
&RegionId=cn-hangzhou
&<公共请求参数>

正常返回示例

XML格式

<clusters>
    <chargeType>PostPaid</chargeType>
    <createResource>ECM_EMR</createResource>
    <createTime>1542784048000</createTime>
    <failReason/>
    <hasUncompletedOrder>false</hasUncompletedOrder>
    <id>C-010A704DA760****</id>
    <name>jy_test_d1_test</name>
    <orderTaskInfo/>
    <runningTime>3138</runningTime>
    <status>RELEASED</status>
    <type>HADOOP</type>
</clusters>
<clusters>
    <chargeType>PostPaid</chargeType>
    <createResource>ECM_EMR</createResource>
    <createTime>1538107586000</createTime>
    <failReason/>
    <hasUncompletedOrder>false</hasUncompletedOrder>
    <id>C-B9712209060C****</id>
    <name>intelligence-313-yp</name>
    <orderTaskInfo/>
    <runningTime>2069400</runningTime>
    <status>RELEASED</status>
    <type>HADOOP</type>
</clusters>
<clusters>
    <chargeType>PostPaid</chargeType>
    <createResource>ECM_EMR</createResource>
    <createTime>1536546078000</createTime>
    <failReason/>
    <hasUncompletedOrder>false</hasUncompletedOrder>
    <id>C-4CD9EBBD6B23****</id>
    <name>mg-storm</name>
    <orderTaskInfo/>
    <runningTime>1382155</runningTime>
    <status>RELEASED</status>
    <type>HADOOP</type>
</clusters>
<clusters>
    <chargeType>PostPaid</chargeType>
    <createResource>ECM_EMR</createResource>
    <createTime>1535363759000</createTime>
    <failReason/>
    <hasUncompletedOrder>false</hasUncompletedOrder>
    <id>C-75D6EE95D722****</id>
    <name>df-3101-upgrade-test</name>
    <orderTaskInfo/>
    <runningTime>676284</runningTime>
    <status>RELEASED</status>
    <type>HADOOP</type>
</clusters>
<clusters>
    <chargeType>PostPaid</chargeType>
    <createResource>ECM_EMR</createResource>
    <createTime>1534492361000</createTime>
    <failReason>
        <errorCode>InvalidImageId.NotFound</errorCode>
        <errorMsg>The specified ImageId does not exist.</errorMsg>
        <requestId>B8DC3A91-3953-4444-92BB-DBC29C47EC1A</requestId>
    </failReason>
    <hasUncompletedOrder>false</hasUncompletedOrder>
    <id>C-5EF0F3C257B1****</id>
    <name>测试集群1</name>
    <orderTaskInfo/>
    <runningTime>0</runningTime>
    <status>CREATE_FAILED</status>
    <type>HADOOP</type>
</clusters>
<pageNumber>1</pageNumber>
<pageSize>5</pageSize>
<requestId>5443DB14-4641-4DFF-9226-4888EC5A2EA9</requestId>
<totalCount>11</totalCount>

JSON格式

{
    "clusters": [
        {
            "chargeType": "PostPaid",
            "createResource": "ECM_EMR",
            "createTime": 1542784048000,
            "failReason": {},
            "hasUncompletedOrder": false,
            "id": "C-010A704DA760****",
            "name": "jy_test_d1_test",
            "orderTaskInfo": {},
            "runningTime": 3138,
            "status": "RELEASED",
            "type": "HADOOP"
        },
        {
            "chargeType": "PostPaid",
            "createResource": "ECM_EMR",
            "createTime": 1538107586000,
            "failReason": {},
            "hasUncompletedOrder": false,
            "id": "C-B9712209060C****",
            "name": "intelligence-313-yp",
            "orderTaskInfo": {},
            "runningTime": 2069400,
            "status": "RELEASED",
            "type": "HADOOP"
        },
        {
            "chargeType": "PostPaid",
            "createResource": "ECM_EMR",
            "createTime": 1536546078000,
            "failReason": {},
            "hasUncompletedOrder": false,
            "id": "C-4CD9EBBD6B23****",
            "name": "mg-storm",
            "orderTaskInfo": {},
            "runningTime": 1382155,
            "status": "RELEASED",
            "type": "HADOOP"
        },
        {
            "chargeType": "PostPaid",
            "createResource": "ECM_EMR",
            "createTime": 1535363759000,
            "failReason": {},
            "hasUncompletedOrder": false,
            "id": "C-75D6EE95D722****",
            "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-5EF0F3C257B1****",
            "name": "测试集群1",
            "orderTaskInfo": {},
            "runningTime": 0,
            "status": "CREATE_FAILED",
            "type": "HADOOP"
        }
    ],
    "pageNumber": 1,
    "pageSize": 5,
    "requestId": "5443DB14-4641-4DFF-9226-4888EC5A2EA9",
    "totalCount": 11
}