文档中心

ListClusters（集群列表）

最近更新时间：2022.10.09 10:28:00

首次发布时间：2022.10.09 10:28:00

1 接口说明

名称： ListClusters
使用场景： 调用 ListClusters，查询该账号下所有 E-MapReduce（EMR）集群。
前置条件： 已使用账号登录火山引擎。

2 请求参数

RequestParam:
TOP公共参数：
Action=ListClusters
Version=2022-06-30
Region=cn-beijing
POST

名称	类型	必填	描述	示例
ClusterId	String	N	EMR 集群的集群 ID，精确搜索	emr-xxx
ClusterName	String	N	EMR 集群的名称，模糊搜索	cluster-test-01
SearchKey	String	N	集群名称或 ID	emr-xxx
StartDate	Date	N	查询从该时间创建的 EMR 集群	2022-04-15
EndDate	Date	N	查询直到该时间创建的 EMR 集群	2022-04-15
PayType	String	N	集群支付类型（包年包月/按量付费）	PRE
ClusterType	Array	N	集群类型	Hadoop
Status	Array	N	EMR 集群状态	RUNNING
CreateTimeOrder	String	N	EMR 集群排序（创建时间）	DESC（降序）
ReleaseTimeOrder	String	N	EMR 集群释放时间排序	DESC
ProjectName	String	N	EMR 集群所属项目名称	default
ExpirationStatus	String	N	EMR 集群过期状态，取值如下 WAIT_RENEWAL, WILL_EXPIRED, NOT_EXPIRED_SOON, NONE;	WAIT_RENEWAL
Tags	Array	N	EMR集群标签	[{ "TagKey": "k" }]
PageNum	Int	N	页号	0
PageSize	Int	N	单页记录数	1

3 返回示例

{
    "ResponseMetadata":{
        "RequestId":"2022041414384001022524314703xxx",
        "Action":"ListClusters",
        "Version":"2022-06-30",
        "Service":"emr_qa",
        "Region":"cn-guilin-boe",
        "Error":null
    },
    "Result":{
        "items":[
            {
                "ClusterId":"emr-xxx",
                "AccountId":2100001324,
                "ClusterName":"lixue-自动续费",
                "ClusterType":"Hadoop",
                "Status":"RUNNING",
                "ReleaseVersion":"1.2.0",
                "PayType":"PRE",
                "Project":"default",
                "CreatorId":2100001324,
                "CreatorName":"emr_dev",
                "ExpireTime":"2022-05-13 23:59:59",
                "LaunchTime":"2022-04-13T20:01:10",
                "CreateTime":"2022-04-13T19:29:10",
                "ClusterMetadataHostingType":"BUILT_IN_MYSQL",
                "KerberosStatus":"DISABLED",
            }
        ],
        "total":49,
        "pages":10,
        "pageNum":0,
        "pageSize":1
    }
}

1 接口说明

2 请求参数

3 返回示例