ListClusters - 查询集群

查询EMR集群列表。

调试

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

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

emr:ListClusters

list

*全部资源

*

请求参数

名称

类型

必填

描述

示例值

RegionId

string

区域 ID。

cn-hangzhou

NextToken

string

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

eyJlY21OZXh0VG9rZW4iOiIxIiwidGFpaGFvTmV4dFRva2VuIjoiNTYiLCJ0YWloYW9OZXh0VG9rZW5JbnQiOjU2LCJlY21OZXh0VG9rZW5JbnQiOjF9

MaxResults

integer

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

20

ClusterName

string

集群名称。

emrtest

ResourceGroupId

string

资源组 ID。

rg-acfmzabjyop****

ClusterIds

array

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

rg-acfmzabjyop****

string

集群 ID。

c-b933c5aac8fe****

ClusterTypes

array

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

["c-b933c5aac8fe****"]

string

集群类型。取值范围:

  • DATALAKE:新版数据湖。

  • OLAP:数据分析。

  • DATAFLOW:实时数据流。

  • DATASERVING:数据服务。

  • CUSTOM:自定义混部集群。

  • HADOOP:旧版数据湖。

DATALAKE

ClusterStates

array

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

["HADOOP"]

string

集群状态。取值范围:

  • STARTING:启动中。

  • START_FAILED:启动失败。

  • BOOTSTRAPPING:引导操作初始化。

  • RUNNING:运行中。

  • TERMINATING:终止中。

  • TERMINATED:已终止。

  • TERMINATED_WITH_ERRORS:发生异常导致终止

  • TERMINATE_FAILED:终止失败。

RUNNING

PaymentTypes

array

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

["ECS"]

string

付费类型。取值范围:

  • PayAsYouGo:后付费。

  • Subscription:预付费。

PayAsYouGo

Tags

array

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

["PayAsYouGo"]

Tag

标签。

返回参数

名称

类型

描述

示例值

object

返回数据。

Clusters

array

集群列表。

ClusterSummary

集群信息。

RequestId

string

请求 ID。

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

NextToken

string

下页页码。

eyJlY21OZXh0VG9rZW4iOiIxIiwidGFpaGFvTmV4dFRva2VuIjoiNTYiLCJ0YWloYW9OZXh0VG9rZW5JbnQiOjU2LCJlY21OZXh0VG9rZW5JbnQiOjF9

MaxResults

integer

分页大小。

20

TotalCount

integer

分页总数。

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": "AliyunEMRDefaultRole",
      "Description": "EMR cluster",
      "DeletionProtection": false
    }
  ],
  "RequestId": "9E3A7161-EB7B-172B-8D18-FFB06BA3896A",
  "NextToken": "eyJlY21OZXh0VG9rZW4iOiIxIiwidGFpaGFvTmV4dFRva2VuIjoiNTYiLCJ0YWloYW9OZXh0VG9rZW5JbnQiOjU2LCJlY21OZXh0VG9rZW5JbnQiOjF9",
  "MaxResults": 20,
  "TotalCount": 1000
}

错误码

HTTP status code

错误码

错误信息

描述

400 ConflictParameters Parameters that must not be used together. %s 多个参数间存在冲突。
400 IncompleteSignature The request signature is invalid. API请求签名不合法。
400 InvalidAction The action %s requested is invalid. 不合法的Action。
400 InvalidParameter The specified parameter %s is not valid. 参数错误。
400 InvalidParameterValue The input parameter %s is invalid or out of range. 参数值超出范围。
400 MissingAction The action %s requested is missing. 缺少Action参数
400 MissingParameter The input parameter %s that is mandatory for processing this request is not supplied. 参数缺失。
400 NotAuthorized You do not have permission to perform this action. %s 没有权限。
400 ThrottlingException The request was denied due to request throttling. %s 限流。
500 InternalError The request processing has failed due to some unknown error, exception or failure. 内部错误。
404 ResourceNotFound The resource not found by %s. 请求的资源未找到。
503 ServiceFailure The request has failed due to a temporary failure of %s service. 依赖的阿里云其他服务不可用。
503 ServiceUnavailable The request has failed due to a temporary failure of the server. 请求超时或者服务不可用。

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

变更历史

更多信息,参考变更详情