All Products
Search
Document Center

E-MapReduce:ListNodeGroups

Last Updated:Jan 10, 2024

Queries the list of node groups in an EMR cluster.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The ID of the region in which you want to create the instance.

cn-hangzhou
ClusterIdstringYes

The cluster ID.

c-b933c5aac8fe****
NextTokenstringNo

Marks the current position where reading starts. If you set this value to null, you can start from the beginning.

DD6B1B2A-5837-5237-ABE4-FF0C89568980
MaxResultsintegerNo

The number of maximum number of records to obtain at a time. Valid values: 1 to 100.

20
NodeGroupIdsarrayNo

The IDs of node groups. Valid values of the number of array elements N: 1 to 100.

stringNo

The ID of the node group.

ng-869471354ecd****
NodeGroupNamesarrayNo

The list of node group names. Valid values of the number of array elements N: 1 to 100.

stringNo

The name of the node group.

core-1
NodeGroupTypesarrayNo

The list of node group types. Valid values of the number of array elements N: 1 to 100.

stringNo

The type of the node group. Valid values:

  • MASTER: master node group
  • CORE: core node group
  • TASK: task node group
CORE
NodeGroupStatesarrayNo

The status of the node group. Valid values of the number of array elements N: 1 to 100.

stringNo

The status of the node group. Valid values:

  • PROVISIONING: The instance is being initialized.
  • INCREASING: The cluster is being scaled out.
  • DECREASING: The instance is being scaled in.
  • SUSPENDED: suspended.
  • RUNNING: The job connector is running.
  • RECONFIGURING: The configuration is being changed.
  • TERMINATING: The instance is being terminated.
  • TERMINATED: The instance is terminated.
RESIZING

Response parameters

ParameterTypeDescriptionExample
object

The returned data.

NodeGroupsarray

The array of node groups.

NodeGroup

The node group.

RequestIdstring

The ID of the request.

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

Returns the location of the data that was read. Empty indicates that the data has been read.

DD6B1B2A-5837-5237-ABE4-FF0C89568980
MaxResultsinteger

The maximum number of entries returned.

20
TotalCountinteger

The total number of entries returned.

200

Examples

Sample success responses

JSONformat

{
  "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",
      "Status": "CREATED",
      "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": "",
        "LimitCpu": 0,
        "LimitMemory": "",
        "DataDiskStorageClass": "",
        "DataDiskSize": 0,
        "CustomLabels": [
          {
            "Key": "department",
            "Value": "IT"
          }
        ],
        "CustomAnnotations": [
          {
            "Key": "department",
            "Value": "IT"
          }
        ],
        "MountHostCgroup": true
      },
      "IaaSType": ""
    }
  ],
  "RequestId": "DD6B1B2A-5837-5237-ABE4-FF0C8944****",
  "NextToken": "DD6B1B2A-5837-5237-ABE4-FF0C89568980",
  "MaxResults": 20,
  "TotalCount": 200
}

Error codes

HTTP status codeError codeError message
400ConflictParametersParameters that must not be used together. %s
400IncompleteSignatureThe request signature is invalid.
400InvalidActionThe action %s requested is invalid.
400InvalidParameterThe specified parameter %s is not valid.
400InvalidParameterValueThe input parameter %s is invalid or out of range.
400MissingActionThe action %s requested is missing.
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.

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2023-12-07The internal configuration of the API is changed, but the call is not affectedsee changesets
Change itemChange content
The internal configuration of the API is changed, but the call is not affected.