文档

ListClusters - 查询集群

更新时间:

查询EMR集群列表。

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
RegionIdstring

区域 ID。

枚举值:
  • cn-qingdao
  • cn-beijing
  • cn-zhangjiakou
  • cn-huhehaote
  • cn-hangzhou
  • cn-shanghai
  • cn-shenzhen
  • cn-chengdu
  • cn-hongkong
  • cn-wulanchabu
  • cn-heyuan-acdr-1
  • cn-qingdao-acdr-ut-1
  • ap-northeast-1
  • ap-southeast-1
  • ap-southeast-2
  • ap-southeast-3
  • ap-southeast-5
  • ap-south-1
  • us-east-1
  • us-west-1
  • me-east-1
  • me-central-1
  • eu-central-1
  • eu-west-1
  • cn-north-2-gov-1
cn-hangzhou
NextTokenstring

标记当前开始读取的位置,置空表示从头开始。

eyJlY21OZXh0VG9rZW4iOiIxIiwidGFpaGFvTmV4dFRva2VuIjoiNTYiLCJ0YWloYW9OZXh0VG9rZW5JbnQiOjU2LCJlY21OZXh0VG9rZW5JbnQiOjF9
MaxResultsinteger

一次获取的最大记录数。取值范围:1~100。

20
ClusterNamestring

集群名称。

emrtest
ResourceGroupIdstring

资源组 ID。

rg-acfmzabjyop****
ClusterIdsarray

集群 ID 列表。数组元素个数 N 的取值范围:1~100。

string

集群 ID。

c-b933c5aac8fe****
ClusterTypesarray

集群类型列表。数组元素个数 N 的取值范围:1~100。

string

集群类型。取值范围:

  • DATALAKE:新版数据湖。
  • OLAP:数据分析。
  • DATAFLOW:实时数据流。
  • DATASERVING:数据服务。
  • CUSTOM:自定义混部集群。
  • HADOOP:旧版数据湖。
DATALAKE
ClusterStatesarray

集群状态数组。数组元素个数 N 的取值范围:1~100。

string

集群状态。取值范围:

  • STARTING:启动中。
  • START_FAILED:启动失败。
  • BOOTSTRAPPING:引导操作初始化。
  • RUNNING:运行中。
  • TERMINATING:终止中。
  • TERMINATED:已终止。
  • TERMINATED_WITH_ERRORS:发生异常导致终止
  • TERMINATE_FAILED:终止失败。
RUNNING
PaymentTypesarray

付费类型。数据元素个数 N 的取值范围:1~2。

string

付费类型。取值范围:

  • PayAsYouGo:后付费。
  • Subscription:预付费。
PayAsYouGo
Tagsarray

标签列表。数组元素个数 N 取值范围:1~20。

Tag

标签。

返回参数

名称类型描述示例值
object

返回数据。

Clustersarray

集群列表。

ClusterSummary

集群信息。

RequestIdstring

请求 ID。

9E3A7161-EB7B-172B-8D18-FFB06BA3896A
NextTokenstring

下页页码。

eyJlY21OZXh0VG9rZW4iOiIxIiwidGFpaGFvTmV4dFRva2VuIjoiNTYiLCJ0YWloYW9OZXh0VG9rZW5JbnQiOjU2LCJlY21OZXh0VG9rZW5JbnQiOjF9
MaxResultsinteger

分页大小。

20
TotalCountinteger

分页总数。

1000

示例

正常返回示例

JSON格式

{
  "Clusters": [
    {
      "ClusterId": "c-b933c5aac8fe****",
      "ClusterName": "emrtest",
      "ClusterType": "DATALAKE",
      "ClusterState": "RUNNING",
      "PaymentType": "PayAsYouGo",
      "CreateTime": 1592837465788,
      "ReadyTime": 1592837465788,
      "ExpireTime": 1592837475788,
      "EndTime": 1592837485788,
      "ReleaseVersion": "EMR-5.8.0",
      "ResourceGroupId": "rg-acfmzabjyop****",
      "StateChangeReason": {
        "Code": "OutOfStock",
        "Message": "The requested resource is sold out in the specified zone, try other types of resources or other regions and zones."
      },
      "Tags": [
        {
          "Key": "department",
          "Value": "IT"
        }
      ],
      "EmrDefaultRole": ""
    }
  ],
  "RequestId": "9E3A7161-EB7B-172B-8D18-FFB06BA3896A",
  "NextToken": "eyJlY21OZXh0VG9rZW4iOiIxIiwidGFpaGFvTmV4dFRva2VuIjoiNTYiLCJ0YWloYW9OZXh0VG9rZW5JbnQiOjU2LCJlY21OZXh0VG9rZW5JbnQiOjF9",
  "MaxResults": 20,
  "TotalCount": 1000
}

错误码

HTTP status code错误码错误信息描述
400ConflictParametersParameters that must not be used together. %s多个参数间存在冲突。
400IncompleteSignatureThe request signature is invalid.API请求签名不合法。
400InvalidActionThe action %s requested is invalid.不合法的Action。
400InvalidParameterThe specified parameter %s is not valid.参数错误。
400InvalidParameterValueThe input parameter %s is invalid or out of range.参数值超出范围。
400MissingActionThe action %s requested is missing.缺少Action参数
400MissingParameterThe input parameter %s that is mandatory for processing this request is not supplied.参数缺失。
400NotAuthorizedYou do not have permission to perform this action. %s没有权限。
400ThrottlingExceptionThe request was denied due to request throttling. %s限流。
404ResourceNotFoundThe resource not found by %s.请求的资源未找到。
500InternalErrorThe request processing has failed due to some unknown error, exception or failure.内部错误。
503ServiceFailureThe request has failed due to a temporary failure of %s service.依赖的阿里云其他服务不可用。
503ServiceUnavailableThe request has failed due to a temporary failure of the server.请求超时或者服务不可用。

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2023-12-12API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
2023-12-07API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
2023-10-23API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
2023-08-09API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
2023-08-04API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
  • 本页导读 (1)