ListNodeGroups - E-MapReduce - Alibaba Cloud Documentation Center

Queries the node groups in an EMR cluster.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

emr:ListNodeGroups

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID.	cn-hangzhou
ClusterId	string	Yes	The cluster ID.	c-b933c5aac8fe****
NextToken	string	No	The token that marks the start of the query. Leave this parameter empty to start from the beginning.	DD6B1B2A-5837-5237-ABE4-FF0C89568980
MaxResults	integer	No	The maximum number of records to return in a single request. Valid values: 1 to 100.	20
NodeGroupIds	array	No	A list of node group IDs. The number of array elements N can range from 1 to 100.	c-b933c5aac8fe****
	string	No	The node group ID.	ng-869471354ecd****
NodeGroupNames	array	No	A list of node group names. The number of array elements N can range from 1 to 100.	DD6B1B2A-5837-5237-ABE4-FF0C89568980
	string	No	The node group name.	core-1
NodeGroupTypes	array	No	A list of node group types. The number of array elements N can range from 1 to 100.	20
	string	No	The type of the node group. Valid values: MASTER: The master node group. CORE: The core node group. TASK: The task node group.	CORE
NodeGroupStates	array	No	The state of the node group. The number of array elements N can range from 1 to 100.	["CORE"]
	string	No	The state of the node group. Valid values: PROVISIONING: The node group is being initialized. INCREASING: The node group is scaling out. DECREASING: The node group is scaling in. SUSPENDED: The node group is suspended. RUNNING: The node group is running. RECONFIGURING: The node group is being reconfigured. TERMINATING: The node group is being terminated. TERMINATED: The node group is terminated.	RUNNING
ZoneId	string	No

Response elements

Element	Type	Description	Example
	object	The response data.
NodeGroups	array	An array of node groups.
	NodeGroup	The node group.
RequestId	string	The request ID.	DD6B1B2A-5837-5237-ABE4-FF0C8944****
NextToken	string	The token to retrieve the next page of results. An empty value indicates that all results have been returned.	DD6B1B2A-5837-5237-ABE4-FF0C89568980
MaxResults	integer	The maximum number of entries returned for the request.	20
TotalCount	integer	The total number of entries that match the query conditions.	200

Examples

Success response

JSON format

{
  "NodeGroups": [
    {
      "ZoneId": "cn-beijing-h",
      "NodeGroupId": "ng-869471354ecd****",
      "NodeGroupName": "core-1",
      "NodeGroupType": "CORE",
      "RunningNodeCount": 3,
      "InstanceTypes": [
        ""
      ],
      "PaymentType": "PayAsYouGo",
      "DataDisks": [
        {
          "Category": "cloud_essd",
          "Size": 80,
          "PerformanceLevel": "PL1",
          "Count": 5
        }
      ],
      "SystemDisk": {
        "Category": "cloud_essd",
        "Size": 60,
        "PerformanceLevel": "PL1",
        "Count": 1
      },
      "NodeGroupState": "CREATED",
      "AdditionalSecurityGroupIds": [
        ""
      ],
      "WithPublicIp": false,
      "VSwitchIds": [
        ""
      ],
      "SpotStrategy": "NoSpot",
      "SpotBidPrices": [
        {
          "InstanceType": "ecs.g7.2xlarge",
          "BidPrice": 1000
        }
      ],
      "StateChangeReason": {
        "Code": "MissingParameter",
        "Message": "The instance type is required."
      },
      "MinimalNodeCount": 0,
      "MaximalNodeCount": 200,
      "GracefulShutdown": false,
      "SpotInstanceRemedy": true,
      "CompensateWithOnDemand": true,
      "NodeResizeStrategy": "PRIORITY",
      "CostOptimizedConfig": {
        "OnDemandBaseCapacity": 80,
        "OnDemandPercentageAboveBaseCapacity": 80,
        "SpotInstancePools": 2
      },
      "DeploymentSetStrategy": "NONE",
      "AutoCompensateState": true,
      "ExtraAttributes": {
        "key": ""
      },
      "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
}

Error codes

HTTP status code	Error code	Error message
400	ConflictParameters	Parameters that must not be used together. %s
400	IncompleteSignature	The request signature is invalid.
400	InvalidAction	The action %s requested is invalid.
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.
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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.