ListNodeGroups - 查询节点组

更新时间:
复制 MD 格式

查询EMR集群节点组列表。

调试

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

调试

授权信息

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

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

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

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

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

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

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

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

操作

访问级别

资源类型

条件关键字

关联操作

emr:ListNodeGroups

list

*全部资源

*

无 无

请求参数

名称

类型

必填

描述

示例值

RegionId

string

是

地域 ID。

cn-hangzhou

ClusterId

string

是

集群 ID。

c-b933c5aac8fe****

NextToken

string

否

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

DD6B1B2A-5837-5237-ABE4-FF0C89568980

MaxResults

integer

否

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

20

NodeGroupIds

array

否

节点组 ID 列表。数组元素个数 N 取值范围:1~100。

c-b933c5aac8fe****

string

否

节点分组 ID。

ng-869471354ecd****

NodeGroupNames

array

否

节点组名称列表。数组元素个数 N 取值范围:1~100。

DD6B1B2A-5837-5237-ABE4-FF0C89568980

string

否

节点组名称。

core-1

NodeGroupTypes

array

否

节点组类型列表。数组元素个数 N 取值范围:1~100。

20

string

否

节点组类型。取值范围:

  • MASTER:管理类型节点组。

  • CORE:存储类型节点组。

  • TASK:计算类型节点组。

CORE

NodeGroupStates

array

否

节点组状态。数组元素个数 N 取值范围:1~100。

["CORE"]

string

否

节点组状态。取值范围:

  • PROVISIONING:初始化中。

  • INCREASING:扩容中。

  • DECREASING:缩容中。

  • SUSPENDED:挂起。

  • RUNNING:运行中。

  • RECONFIGURING:变配中。

  • TERMINATING:终止中。

  • TERMINATED:已终止。

RUNNING

ZoneId

string

否

可用区 ID,用于筛选节点组。

cn-beijing-h

返回参数

名称

类型

描述

示例值

object

返回数据

NodeGroups

array

节点组数组。

NodeGroup

节点组。

RequestId

string

请求 ID。

DD6B1B2A-5837-5237-ABE4-FF0C8944****

NextToken

string

返回读取到的数据位置。空代表数据已经读取完毕。

DD6B1B2A-5837-5237-ABE4-FF0C89568980

MaxResults

integer

本次请求所返回的最大记录条数。

20

TotalCount

integer

本次请求条件下的数据总量。

200

示例

正常返回示例

JSON格式

{
  "NodeGroups": [
    {
      "WithPublicIp": true,
      "SpotInstanceRemedy": false,
      "DataDisks": [
        {
          "Category": "cloud_essd",
          "Size": 80,
          "PerformanceLevel": "PL1",
          "Count": 5
        }
      ],
      "CompensateWithOnDemand": true,
      "NodeGroupState": "RESIZING",
      "SystemDisk": {
        "Category": "cloud_essd",
        "Size": 60,
        "PerformanceLevel": "PL1",
        "Count": 1
      },
      "PrivatePoolOptions": {
        "MatchCriteria": "Open",
        "PrivatePoolIds": [
          "crp-xxxx"
        ]
      },
      "NodeGroupType": "MASTER",
      "PaymentType": "Subscription",
      "InstanceTypes": [
        "ecs.g7.2xlarge"
      ],
      "CostOptimizedConfig": {
        "OnDemandBaseCapacity": 80,
        "OnDemandPercentageAboveBaseCapacity": 80,
        "SpotInstancePools": 2
      },
      "GracefulShutdown": false,
      "SpotStrategy": "NoSpot",
      "StateChangeReason": {
        "Message": "The instance type is required.",
        "Code": "UserRequest"
      },
      "Status": "CREATED",
      "ZoneId": "cn-hangzhou",
      "NodeGroupName": "core-1",
      "VSwitchIds": [
        "vsw-bp1opd2qejvhsabfe****"
      ],
      "SpotBidPrices": [
        {
          "BidPrice": 1000,
          "InstanceType": "ecs.g7.2xlarge"
        }
      ],
      "NodeResizeStrategy": "PRIORITY",
      "NodeGroupId": "ng-869471354ecd****",
      "AdditionalSecurityGroupIds": [
        "sg-hp3abbae8lb6lmb1****"
      ],
      "DeploymentSetStrategy": "NONE",
      "RunningNodeCount": 3
    }
  ],
  "RequestId": "DD6B1B2A-5837-5237-ABE4-FF0C8944****",
  "NextToken": "DD6B1B2A-5837-5237-ABE4-FF0C89568980",
  "MaxResults": 20,
  "TotalCount": 200
}

错误码

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. 请求超时或者服务不可用。

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

变更历史

更多信息,参考变更详情。