You need to enable JavaScript to run this app.
导航

ListClusters - 集群列表

最近更新时间2024.01.22 15:56:32

首次发布时间2024.01.22 15:56:32

集群列表查询

使用说明

调用 ListClusters,查询该账号下所有 E-MapReduce(EMR)集群。

注意事项

已使用账号登录火山引擎。

请求说明

请求方式:POST
请求地址:https://open.volcengineapi.com/?Version=2023-08-15&Action=ListClusters

调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数

参数
类型
是否必填
示例值
描述
Action
String

ListClusters

要执行的操作,取值:ListClusters

Version
String

2023-08-15

API的版本,取值:2023-08-15

ClusterName
String

OpenApiHadoop3.7.0-xxx

集群名称,模糊查询

ClusterId
String

emr-xxx

集群ID,模糊查询

ReleaseVersion
String

3.7.0

集群版本

ProjectName
String

default

项目名称

CreateTimeBefore
String

1701764286000

开始日期,时间戳单位ms

CreateTimeAfter
String

1701764286300

结束日期,时间戳单位ms

ClusterIds
Array of String

["emr-xxx]

集群ID列表

ClusterTypes
Array of String

["Hadoop"]

集群类型列表

ClusterStates
Array of String

["RUNNING"]

集群状态列表

ChargeTypes
Array of String

["POST"]

集群付费类型列表

Tags
Array of Tag

xxx

标签列表

MaxResults
Integer

10

返回的最大记录数

NextToken
String

57N8YtDWxxx

分页查询的下一页token

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构

参数
类型
示例值
描述
RegionId
String

cn-beijing

地域ID

ProjectName
String

default

项目名称

ClusterId
String

emr-xxx

集群ID

ClusterName
String

OpenApiHadoop3.7.0-xxx

集群名称

ClusterType
String

Hadoop

集群类型

ReleaseVersion
String

3.7.0

集群版本

SecurityGroupId
String

sg-xxx

集群全局安全组ID

VpcId
String

vpc-xxx

私有网络

Creator
String

6xxx

创建者

AccountId
String

210xxx

账号ID

NodeAttribute
NodeAttribute

{
"ZoneId": "cn-beijing-b",
"EcsIamRole": "VEECSforEMRRole"
}

集群的全局节点属性

ClusterState
String

PENDING_FOR_PAYMENT,CREATING,RUNNING,TERMINATING,TERMINATED,TERMINATED_WITH_ERROR,FAILED,SHUTDOWN

集群状态

ChargeType
String

PRE,POST

付费类型

CreateTime
Long

1701764286214

创建时间, 单位ms

ReadyTime
Long

1701764779378

集群创建完成时间,单位ms

ExpireTime
Long

1701764286214

集群过期时间

TerminateTime
Long

1701764286214

集群终止时间

StateChangeReason
StateChangeReason

xxx

状态变更原因

请求示例

{
    "ClusterId":"emr-xxx"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20231205174720B3E08B8D2FB8E9xxx",
        "Action": "ListClusters",
        "Version": "2023-08-15",
        "Service": "emr",
        "Region": "cn-beijing",
        "Error": null,
        "Deprecated": false
    },
    "Result": {
        "Items": [
            {
                "RegionId": "cn-beijing",
                "ProjectName": "default",
                "ClusterId": "emr-xxx",
                "ClusterName": "OpenApiHadoop3.7.0-xxx",
                "ClusterType": "Hadoop",
                "ReleaseVersion": "3.7.0",
                "SecurityGroupId": "sg-xxx",
                "VpcId": "xxx",
                "Creator": "6xxx",
                "AccountId": 2100xxx,
                "NodeAttribute": {
                    "ZoneId": "cn-beijing-b",
                    "EcsIamRole": "VEECSforEMRRole",
                    "LoginUserName": null
                },
                "ClusterState": "RUNNING",
                "ChargeType": "POST",
                "CreateTime": 1701764286214,
                "ReadyTime": 1701764779378,
                "ExpireTime": null,
                "TerminateTime": null,
                "StateChangeReason": null
            }
        ],
        "TotalCount": 1,
        "MaxResults": 10,
        "NextToken": "57N8YtDWZ1LbCkWySngtD53oS+eCiHNIpxxx"
    }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

HttpCode
错误码
错误信息
说明
400
InvalidRequest
Access Denied {clusterId}

对该集群没有权限