CreateDBResourceGroup - AnalyticDB - Alibaba Cloud Documentation Center

Creates a resource group for a cluster.

Operation description

Supported product editions:

Enterprise Edition
Basic Edition
Data Lakehouse Edition
Data Warehouse Edition (Elastic Mode): Requires specifications of 32 cores and 128 GB or higher.

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

adb:CreateDBResourceGroup

create

DBCluster

acs:adb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}

None

Request parameters

Parameter	Type	Required	Description	Example
DBClusterId	string	Yes	The cluster ID. Note Call the DescribeDBClusters operation to query the IDs of all Data Warehouse Edition clusters in the destination region.	am-bp1ub9grke1****
GroupName	string	Yes	The name of the resource group. The name can be up to 255 characters in length. The name must start with a digit or an uppercase letter. The name can contain digits, uppercase letters, hyphens (-), and underscores (_).	TEST_GROUP
GroupType	string	No	The query type. Valid values: interactive (default): interactive query mode. batch: batch query mode. Job: offline job mode.	interactive
MinComputeResource	string	No	The minimum reserved computing resources, in ACU. If the resource group type is Interactive, the minimum reserved computing resources are 16 ACU. If the resource group type is Job, the minimum reserved computing resources are 0 ACU.	0ACU
MaxComputeResource	string	No	The maximum reserved computing resources, in ACU. If the resource group type is Interactive, the maximum reserved computing resources are the current unallocated resources of the cluster. The step size is 16 ACU. If the resource group type is Job, the maximum reserved computing resources are the current unallocated resources of the cluster. The step size is 8 ACU.	32ACU
ClusterSizeResource	string	No	The resource specifications of a single cluster, in ACU.	16ACU
MinClusterCount	integer	No	The minimum number of clusters that must run in the resource group. The minimum value is 1.	1
MaxClusterCount	integer	No	The maximum number of clusters that can run in the resource group. The maximum value is 10.	2
ClusterMode	string	No	The mode of the resource group. Valid values: Disable (default): regular mode. AutoScale: auto-scaling mode.	AutoScale
Engine	string	No	The engine of the resource group. Valid values: AnalyticDB (default): the AnalyticDB for MySQL engine. SparkWarehouse: the SparkWarehouse engine.	AnalyticDB
EngineParams	object	No	The configuration parameters for the Spark application. These parameters apply to all Spark jobs that are executed in the resource group. To configure parameters for a specific Spark job, set the parameters in the code when you submit the job.	{\"spark.adb.version\":\"3.5\"}
NodeNum	integer	No	The number of nodes. The default value is 0. The resources of one node are 16 cores and 64 GB. The number of nodes cannot be too large. The value must meet the following condition: Number of nodes × (16 cores and 64 GB) ≤ Remaining available resources of the cluster.	2
ClientToken	string	No	A client token used to ensure the idempotence of the request. The client generates this value to make sure that it is unique among different requests. The token is case-sensitive and cannot exceed 64 ASCII characters.	123e4567-e89b-12d3-a456-t7241****

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	3A8F6106-6AFD-5A34-9C80-8DE2C42D06E8

Examples

Success response

JSON format

{
  "RequestId": "3A8F6106-6AFD-5A34-9C80-8DE2C42D06E8"
}

Error codes

HTTP status code	Error code	Error message	Description
403	OperationDenied.DBClusterStatus	The operation is not permitted due to cluster status.	This operation is prohibited due to the current state of the cluster.
404	InvalidDBCluster.NotFound	The DBClusterId provided does not exist in our records.	The specified DBClusterId parameter does not exist. Make sure that the DBClusterId value is valid.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.