Queries the list of node groups in an EMR cluster.
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level,
All Resourcesis used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| emr:ListNodeGroups | list |
|
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| RegionId | string | Yes | The ID of the region in which you want to create the instance. | cn-hangzhou |
| ClusterId | string | Yes | The cluster ID. | c-b933c5aac8fe**** |
| NextToken | string | No | 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 |
| MaxResults | integer | No | The number of maximum number of records to obtain at a time. Valid values: 1 to 100. | 20 |
| NodeGroupIds | array | No | The IDs of node groups. Valid values of the number of array elements N: 1 to 100. | |
| String | string | No | The ID of the node group. | ng-869471354ecd**** |
| NodeGroupNames | array | No | The list of node group names. Valid values of the number of array elements N: 1 to 100. | |
| String | string | No | The name of the node group. | core-1 |
| NodeGroupTypes | array | No | The list of node group types. Valid values of the number of array elements N: 1 to 100. | |
| NodeGroupType | string | No | The type of the node group. Valid values:
| CORE |
| NodeGroupStates | array | No | The status of the node group. Valid values of the number of array elements N: 1 to 100. | |
| String | string | No | The status of the node group. Valid values:
| RESIZING |
Response parameters
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": 0,
"LimitCpu": 0,
"LimitMemory": 0,
"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 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 |
| 404 | ResourceNotFound | The resource not found by %s. |
| 500 | InternalError | The request processing has failed due to some unknown error, exception or failure. |
| 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. |
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2023-12-07 | The internal configuration of the API is changed, but the call is not affected | View Change Details |