ListNodeGroups - 查询节点组

查询EMR集群节点组列表。

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
emr:ListNodeGroupslist
*全部资源
*

请求参数

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

地域 ID。

cn-hangzhou
ClusterIdstring

集群 ID。

c-b933c5aac8fe****
NextTokenstring

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

DD6B1B2A-5837-5237-ABE4-FF0C89568980
MaxResultsinteger

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

20
NodeGroupIdsarray

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

Stringstring

节点分组 ID。

ng-869471354ecd****
NodeGroupNamesarray

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

Stringstring

节点组名称。

core-1
NodeGroupTypesarray

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

NodeGroupTypestring

节点组类型。取值范围:

  • MASTER:管理类型节点组。
  • CORE:存储类型节点组。
  • TASK:计算类型节点组。
CORE
NodeGroupStatesarray

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

Stringstring

节点组状态。取值范围:

  • PROVISIONING:初始化中。
  • INCREASING:扩容中。
  • DECREASING:缩容中。
  • SUSPENDED:挂起。
  • RUNNING:运行中。
  • RECONFIGURING:变配中。
  • TERMINATING:终止中。
  • TERMINATED:已终止。
RUNNING

返回参数

名称类型描述示例值
object

返回数据

NodeGroupsarray

节点组数组。

NodeGroupNodeGroup

节点组。

RequestIdstring

请求 ID。

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

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

DD6B1B2A-5837-5237-ABE4-FF0C89568980
MaxResultsinteger

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

20
TotalCountinteger

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

200

示例

正常返回示例

JSON格式

{
  "NodeGroups": [
    {
      "ZoneId": "cn-hangzhou",
      "NodeGroupId": "ng-869471354ecd****",
      "NodeGroupName": "core-1",
      "NodeGroupType": "MASTER",
      "RunningNodeCount": 3,
      "InstanceTypes": [
        "ecs.g7.2xlarge"
      ],
      "PaymentType": "Subscription",
      "DataDisks": [
        {
          "Category": "cloud_essd",
          "Size": 80,
          "PerformanceLevel": "PL1",
          "Count": 5
        }
      ],
      "SystemDisk": {
        "Category": "cloud_essd",
        "Size": 60,
        "PerformanceLevel": "PL1",
        "Count": 1
      },
      "NodeGroupState": "RESIZING",
      "AdditionalSecurityGroupIds": [
        ""
      ],
      "WithPublicIp": true,
      "VSwitchIds": [
        "vsw-bp1opd2qejvhsabfe****"
      ],
      "SpotStrategy": "NoSpot",
      "SpotBidPrices": [
        {
          "InstanceType": "ecs.g7.2xlarge",
          "BidPrice": 1000
        }
      ],
      "StateChangeReason": {
        "Code": "UserRequest",
        "Message": "The instance type is required."
      },
      "MinimalNodeCount": 0,
      "MaximalNodeCount": 200,
      "GracefulShutdown": false,
      "SpotInstanceRemedy": false,
      "NodeResizeStrategy": "PRIORITY",
      "CostOptimizedConfig": {
        "OnDemandBaseCapacity": 80,
        "OnDemandPercentageAboveBaseCapacity": 80,
        "SpotInstancePools": 2
      },
      "DeploymentSetStrategy": "NONE",
      "AutoCompensateState": false,
      "ExtraAttributes": {
        "key": "true"
      },
      "AckConfig": {
        "AckInstanceId": "",
        "NodeSelectors": [
          {
            "Key": "department",
            "Value": "IT"
          }
        ],
        "Tolerations": [
          {
            "Key": "",
            "Value": "",
            "Operator": "",
            "Effect": ""
          }
        ],
        "Namespace": "",
        "RequestCpu": 0,
        "RequestMemory": 0,
        "LimitCpu": 0,
        "LimitMemory": 0,
        "DataDiskStorageClass": "",
        "DataDiskSize": 0,
        "CustomLabels": [
          {
            "Key": "department",
            "Value": "IT"
          }
        ],
        "CustomAnnotations": [
          {
            "Key": "department",
            "Value": "IT"
          }
        ],
        "MountHostCgroup": true,
        "NodeAffinity": "",
        "PodAntiAffinity": "",
        "PodAffinity": "",
        "PreStartCommand": [
          ""
        ],
        "Pvcs": [
          {
            "DataDiskStorageClass": "",
            "DataDiskSize": 0,
            "Path": "",
            "Name": ""
          }
        ],
        "Volumes": [
          {
            "Name": "",
            "Path": "",
            "Type": ""
          }
        ],
        "VolumeMounts": [
          {
            "Name": "",
            "Path": ""
          }
        ]
      },
      "IaaSType": "",
      "PrivatePoolOptions": {
        "PrivatePoolIds": [
          ""
        ],
        "MatchCriteria": "Open"
      },
      "Status": "CREATED"
    }
  ],
  "RequestId": "DD6B1B2A-5837-5237-ABE4-FF0C8944****",
  "NextToken": "DD6B1B2A-5837-5237-ABE4-FF0C89568980",
  "MaxResults": 20,
  "TotalCount": 200
}

错误码

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-07API 内部配置变更,不影响调用查看变更详情