CreateDBResourceGroup - AnalyticDB - Alibaba Cloud Documentation Center

Creates a resource group for an Enterprise Edition, Basic Edition, or Data Lakehouse Edition cluster.

Operation description

For the service endpoints, see Endpoints.

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

*DBClusterLakeVersion

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

None

Request parameters

Parameter	Type	Required	Description	Example
DBClusterId	string	Yes	The ID of the Enterprise Edition, Basic Edition, or Data Lakehouse Edition cluster.	amv-bp11q28kvl688****
GroupName	string	Yes	The name of the resource group. The name can be up to 255 characters in length. It must start with a digit, an uppercase letter, or a lowercase letter. It can contain digits, uppercase letters, lowercase letters, hyphens (-), and underscores (_).	test_group
GroupType	string	Yes	The type of the resource group. Valid values: Interactive Job Note For more information about resource groups in Data Lakehouse Edition, see Introduction to resource groups (Data Lakehouse Edition).	Job
MinComputeResource	string	No	The minimum amount of reserved computing resources, in AnalyticDB compute units (ACUs). If GroupType is set to Interactive, the minimum amount of reserved computing resources is 16 ACUs. If GroupType is set to Job, the minimum amount of reserved computing resources is 0 ACUs.	0ACU
MaxComputeResource	string	No	The maximum amount of reserved computing resources, in ACUs. If GroupType is set to Interactive, the maximum amount of reserved computing resources is the total amount of unassigned resources in the cluster. The resources are allocated in increments of 16 ACUs. If GroupType is set to Job, the maximum amount of reserved computing resources is the total amount of unassigned resources in the cluster. The resources are allocated in increments of 8 ACUs.	48ACU
ClusterSizeResource	string	No	This parameter is reserved.	无
MinClusterCount	integer	No	This parameter is reserved.	无
MaxClusterCount	integer	No	This parameter is reserved.	无
ClusterMode	string	No	This parameter is reserved.	无
EnableSpot	boolean	No	Specifies whether to enable the spot instance feature for the resource group. After you enable this feature, the unit price of resources is reduced, but the resources may be released at any time. This feature is available only for Job resource groups. Valid values: True: Enables the spot instance feature. False: Disables the spot instance feature.	True
RegionId	string	No	The region ID. Note Call the DescribeRegions operation to query the region ID of an AnalyticDB for MySQL Data Lakehouse Edition (V3.0) cluster.	cn-hangzhou
Rules	array<object>	No	The job delivery rules.
	object	No	A list of rule information.
GroupName	string	No	The name of the resource group. The name can be up to 255 characters in length. It must start with a digit, an uppercase letter, or a lowercase letter. It can contain digits, uppercase letters, lowercase letters, hyphens (-), and underscores (_).	test_group
QueryTime	string	No	The threshold for the query running time. Unit: milliseconds (ms).	180000
TargetGroupName	string	No	The name of the target resource group.	job
Engine	string	No	The database engine. Valid values: AnalyticDB (default): the AnalyticDB for MySQL engine. SparkWarehouse: the SparkWarehouse engine.	SparkWarehouse
EngineParams	object	No	The engine configuration.	{\"spark.adb.version\":\"3.5\"}
AutoStopInterval	string	No	The auto-stop time. Unit: minutes (m).	5m
SpecName	string	No	This parameter is reserved.	预留参数，不涉及。
MinGpuQuantity	integer	No	This parameter is reserved.	预留参数，不涉及。
MaxGpuQuantity	integer	No	This parameter is reserved.	预留参数，不涉及。
TargetResourceGroupName	string	No	This parameter is reserved.	预留参数，不涉及。
RayConfig	object	No	The Ray configuration. This parameter is required if the resource group is an AI resource group and the engine is RayCluster.
EnableUserEni	boolean	No
HeadSpecType	string	No
HeadSpec	string	No	The specifications of the head node.	xlarge
HeadAllocateUnit	string	No
HeadDiskCapacity	string	No
Category	string	No	The type of the Ray cluster. Valid values: BASIC: a basic cluster that is not highly available. HIGH_AVAILABILITY: a high-availability cluster.	BASIC
WorkerGroups	array<object>	No	A list of configurations for Ray worker groups.
	object	No	The configuration of a Ray worker group.
GroupName	string	No	The name of the worker group.	test
AllocateUnit	string	No	The allocation unit.	1
MaxWorkerQuantity	integer	No	The maximum number of workers.	2
MinWorkerQuantity	integer	No	The minimum number of workers.	1
WorkerDiskCapacity	string	No	The disk size of a worker node.	100G
WorkerSpecName	string	No	The specifications of a worker node.	xlarge
WorkerSpecType	string	No	The resource type of a worker node.	GPU
GpuElasticPlan	object	No
Enabled	boolean	No
Rules	array<object>	No
	object	No
StartCronExpression	string	No
EndCronExpression	string	No

Response elements

Element	Type	Description	Example
	object	The schema of the response.
RequestId	string	The request ID.	A94B6C02-7BD4-5D67-9776-3AC8317E8DD5

Examples

Success response

JSON format

{
  "RequestId": "A94B6C02-7BD4-5D67-9776-3AC8317E8DD5"
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidPoolName.Malformed	The specified parameter PoolName is not valid.	The PoolName parameter is invalid. Check the parameter.
400	InvalidPoolUser.Malformed	The specified parameter PoolUser is not valid.	The PoolUser parameter is invalid. Check the parameter.
400	InvalidDBClusterId.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.
400	InvalidDBClusterId.Malformed	The specified parameter DBClusterId is not valid.	The DBClusterId parameter is invalid. Check the parameter.
400	InvalidPoolType.Malformed	The specified parameter PoolType is not valid.	The PoolType parameter is invalid. Check the parameter.
400	InvalidMinComputeResource.Malformed	The specified parameter MinComputeResource is not valid.	The MinComputeResource parameter is invalid. Check the parameter.
400	InvalidMaxComputeResource.Malformed	The specified parameter MaxComputeResource is not valid.	The MaxComputeResource parameter is invalid. Check the parameter.
400	ACS.ResourceGroup.InvalidResourceGroupState	The state of this resource group does not support this operation.	This operation is not supported due to the current state of the resource group.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.