DescribeNodeGroups - E-MapReduce - Alibaba Cloud Documentation Center

Retrieves information about node groups.

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

sr:DescribeNodeGroups

get

*All Resource

*

None

Request syntax

POST /webapi/nodegroup/describeNodeGroups HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
PageNumber	integer	No	The page number for a paged query. The default value is 1.	1
PageSize	integer	No	The number of entries per page in a paged query. The default value is 10.	20
ClusterId	string	No	The instance ID.	c-718fb04c7112****
body	object	No	The request parameters.
instanceId	string	No	The instance ID. This parameter is deprecated.	null
componentType	string	No	The type of the compute group. Valid values: FE BE CN OBSERVER AGENT	FE
nodeGroupIds	array	No	The list of compute group IDs to query.
	string	No	The compute group ID.	ng-a9b2e9148196****
nodeGroupName	string	No	The name of the compute group.	ng_1
status	string	No	The status of the compute group. Valid values: UNPAID: Awaiting payment. PAID: Paid. CREATING_FAILED: Creation failed. CREATING: Creating. RUNNING: Running. MODIFYING_CONFIG: Modifying configuration. MODIFYING_TIMEZONE: Modifying time zone. ELASTIC_SCALING_OUT: Elastically scaling out. ELASTIC_SCALING_IN: Elastically scaling in. SCALING_OUT: Scaling out. RESTARTING: Restarting. SCALING_IN: Scaling in. SCALING_UP: Upgrading. SCALING_DOWN: Downgrading. UPGRADING: Upgrading. ENABLE_PUBLIC_NETWORK: Enabling public endpoint. DISABLE_PUBLIC_NETWORK: Disabling public endpoint. SWITCH_AZ: Switching zone. DISABLE: Disabled. DELETING: Deleting. DELETED: Deleted.	RUNNING
tags	array<object>	No
	object	No
key	string	No
value	string	No

Response elements

Element	Type	Description	Example
	object
HttpStatusCode	integer	The HTTP status code of the request.	200
RequestId	string	The request ID.	F285E0EC-E928-5E0B-B2C3-7F3FE42F2BE5
Success	boolean	Indicates whether the request succeeded.	True
ErrCode	string	The error code.	InvalidParams
ErrMessage	string	The error message.	Invalid params: [instance not exists].
Data	array<object>	The returned data.
	array<object>	The returned data.
RegionId	string	The region ID.	cn-hangzhou
InstanceId	string	The instance ID.	c-96f3bc7f04b2****
NodeGroupId	string	The compute group ID.	ng-5e2ba600fee3****
NodeGroupName	string	The name of the compute group.	ng_1
Description	string	The description of the compute group.	ETL计算组
Status	string	The status of the compute group. Valid values: UNPAID: Awaiting payment. PAID: Paid. CREATING_FAILED: Creation failed. CREATING: Creating. RUNNING: Running. MODIFYING_CONFIG: Modifying configuration. MODIFYING_TIMEZONE: Modifying time zone. ELASTIC_SCALING_OUT: Elastically scaling out. ELASTIC_SCALING_IN: Elastically scaling in. SCALING_OUT: Scaling out. RESTARTING: Restarting. SCALING_IN: Scaling in. SCALING_UP: Upgrading. SCALING_DOWN: Downgrading. UPGRADING: Upgrading. ENABLE_PUBLIC_NETWORK: Enabling public endpoint. DISABLE_PUBLIC_NETWORK: Disabling public endpoint. SWITCH_AZ: Switching zone. DISABLE: Disabled. DELETING: Deleting. DELETED: Deleted.	RUNNING
ComponentType	string	The type of the compute group. Valid values: FE BE CN OBSERVER AGENT	FE
PayType	string	The billing method: prePaid: subscription. postPaid: pay-as-you-go.	prePaid
Cu	integer	The number of CUs. A Compute Unit (CU) is the basic unit of measurement for the service. One CU equals 1 CPU core and 4 GiB of memory. For the memory-enhanced instance family, one CU equals 1 CPU core and 8 GiB of memory.	1
MemoryCpuRatio	integer	The ratio of memory size to the number of CUs. The value is 8 if SpecType is ramEnhanced. For other instance types, the value is 4.	4
StorageSize	integer	The storage size in GiB.	100
StoragePerformanceLevel	string	The performance level (PL) of the disk. Valid values: pl0: A single disk provides up to 10,000 random read/write input/output operations per second (IOPS). pl1: A single disk provides up to 50,000 random read/write IOPS. pl2: A single disk provides up to 100,000 random read/write IOPS. pl3: A single disk provides up to 1,000,000 random read/write IOPS.	pl1
DiskNumber	integer	The number of disks.	1
ResidentNodeNumber	integer	The number of nodes.	3
SpecType	string	The instance type of the compute group. Valid values: standard: Standard Edition. localSSD: Local SSD. bigData: Large-storage. ramEnhanced: Memory-enhanced. networkEnhanced: Network-enhanced.	standard
Architecture	string	The architecture of the compute group. Valid values: onEci: Deployed on ECI. onECS: Deployed on ECS. onBareMetal: Deployed on a bare metal resource pool.	onEci
LocalStorageInstanceType	string	The instance type of the local SSD for the node group. This parameter is valid only when the instance is deployed on ECS and SpecType is localSSD or bigData.	local_ssd_4_4xlarge
ElasticNodeNumber	integer	The number of elastic nodes.	3
Endpoint	string	The endpoint of the compute group.	be-c-79b0bb9f58ef****-internal.starrocks.aliyuncs.com
EnablePublicNetwork	boolean	Indicates whether the public endpoint is enabled.	false
PublicAddress	string	The public endpoint. This parameter is returned only when EnablePublicNetwork is true.	fe-c-79b0bb9f58ef****.starrocks.aliyuncs.com
BeginTime	integer	The time when the compute group was created.	1742179008000
ExpireTime	integer	The expiration time of the compute group.	1742179008000
DefaultGroup	boolean	Indicates whether it is the default compute group.	true
RunningTime	integer	The duration for which the compute group has been running, in seconds.	10000
TargetElasticNodeNumber	integer	The target number of elastic nodes.	3
HttpPort	integer	The HTTP port of the compute group.	8030
AccountStatus	string	The account status. Valid values: NORMAL: The account is in a normal state. OVERDUE: The account has an overdue payment.	OVERDUE
BillingInstanceId	string	The ID of the instance that corresponds to the bill. For a default compute group, such as an FE compute group or the default BE compute group, the value of this parameter is the instance ID. Otherwise, the value is the compute group ID.	c-96f3bc7f04b2****
CommodityCode	string	The commodity code.	emapreduce_starrockspost_public_cn
NodeInfo	array<object>	The information about the nodes in the compute group.
	object	The node information.
NodeId	string	The node ID.	cn-e1733d44-0
ZoneId	string	The zone ID.	cn-hangzhou-i
Tags	array<object>
	object
Key	string
Value	string
Total	integer	The total number of entries returned.	100
AccessDeniedDetail	string	Details about the access denied error.	{ "PolicyType": "AccountLevelIdentityBasedPolicy", "AuthPrincipalOwnerId": "xxx", "EncodedDiagnosticMessage": "xxx", "AuthPrincipalType": "xxx", "AuthPrincipalDisplayName": "xxx", "NoPermissionType": "ImplicitDeny", "AuthAction": "sr:xxx" }

Examples

Success response

JSON format

{
  "HttpStatusCode": 200,
  "RequestId": "F285E0EC-E928-5E0B-B2C3-7F3FE42F2BE5",
  "Success": true,
  "ErrCode": "InvalidParams",
  "ErrMessage": "Invalid params: [instance not exists].",
  "Data": [
    {
      "RegionId": "cn-hangzhou",
      "InstanceId": "c-96f3bc7f04b2****",
      "NodeGroupId": "ng-5e2ba600fee3****",
      "NodeGroupName": "ng_1",
      "Description": "ETL计算组",
      "Status": "RUNNING",
      "ComponentType": "FE",
      "PayType": "prePaid",
      "Cu": 1,
      "MemoryCpuRatio": 4,
      "StorageSize": 100,
      "StoragePerformanceLevel": "pl1",
      "DiskNumber": 1,
      "ResidentNodeNumber": 3,
      "SpecType": "standard",
      "Architecture": "onEci",
      "LocalStorageInstanceType": "local_ssd_4_4xlarge",
      "ElasticNodeNumber": 3,
      "Endpoint": "be-c-79b0bb9f58ef****-internal.starrocks.aliyuncs.com",
      "EnablePublicNetwork": false,
      "PublicAddress": "fe-c-79b0bb9f58ef****.starrocks.aliyuncs.com",
      "BeginTime": 1742179008000,
      "ExpireTime": 1742179008000,
      "DefaultGroup": true,
      "RunningTime": 10000,
      "TargetElasticNodeNumber": 3,
      "HttpPort": 8030,
      "AccountStatus": "OVERDUE",
      "BillingInstanceId": "c-96f3bc7f04b2****",
      "CommodityCode": "emapreduce_starrockspost_public_cn",
      "NodeInfo": [
        {
          "NodeId": "cn-e1733d44-0"
        }
      ],
      "ZoneId": "cn-hangzhou-i",
      "Tags": [
        {
          "Key": "",
          "Value": ""
        }
      ]
    }
  ],
  "Total": 100,
  "AccessDeniedDetail": "{     \"PolicyType\": \"AccountLevelIdentityBasedPolicy\",     \"AuthPrincipalOwnerId\": \"xxx\",     \"EncodedDiagnosticMessage\": \"xxx\",     \"AuthPrincipalType\": \"xxx\",     \"AuthPrincipalDisplayName\": \"xxx\",     \"NoPermissionType\": \"ImplicitDeny\",     \"AuthAction\": \"sr:xxx\"   }"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.