Modify a resource group with ModifyDBResourceGroup - AnalyticDB - Alibaba Cloud - AnalyticDB

Changes the resource group of a cluster.

Operation description

For the endpoint of this service, refer to Endpoint.

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:ModifyDBResourceGroup

update

*DBClusterLakeVersion

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

None

Request parameters

Parameter	Type	Required	Description	Example
DBClusterId	string	Yes	The cluster ID of the Data Lakehouse Edition cluster.	amv-bp1r053byu48p****
GroupName	string	Yes	The resource group name. Note You can call the DescribeDBResourceGroup operation to query the resource group names of a specified cluster.	test
GroupType	string	Yes	The resource group type. Valid values: Interactive Job Note For more information about Data Lakehouse Edition resource groups, refer to Resource group introduction.	Interactive
MinComputeResource	string	No	The minimum reserved computing resources. If the resource group type is Interactive, the minimum reserved computing resources are 16 ACUs. If the resource group type is Job, the minimum reserved computing resources are 0 ACUs.	0ACU
MaxComputeResource	string	No	The maximum reserved computing resources. If the resource group type is Interactive, the maximum reserved computing resources are the current unallocated resources of the cluster, in increments of 16 ACUs. If the resource group type is Job, the maximum reserved computing resources are the current unallocated resources of the cluster, in increments of 8 ACUs.	48ACU
ClusterSizeResource	string	No	Reserved parameter (not applicable).	None
MinClusterCount	integer	No	Reserved parameter (not applicable).	None
MaxClusterCount	integer	No	Reserved parameter (not applicable).	None
ClusterMode	string	No	Reserved parameter (not applicable).	None
EnableSpot	boolean	No	Specifies whether to enable the spot instance feature for the resource group. After spot instances are enabled, the unit price of resources is reduced, but the resources may be released. Only Job resource groups support this feature. Valid values: True: Enables the spot instance feature. False: Disables the spot instance feature.	True
RegionId	string	No	The region ID. Note You can call the DescribeRegions operation to query the region ID of a specified cluster.	cn-hangzhou
Rules	array<object>	No	The job routing rules.
	object	No	The list of rule information.
GroupName	string	No	The resource group name.	user_default
QueryTime	string	No	The query execution time threshold. Unit: milliseconds (ms).	180000
TargetGroupName	string	No	The target resource group name.	job
EngineParams	object	No	The engine configuration.	{\"spark.adb.version\":\"3.5\"}
	any	No
AutoStopInterval	string	No	The auto-stop interval.	5m
SpecName	string	No	Reserved parameter (not applicable).	Reserved parameter. Not applicable.
MinGpuQuantity	integer	No	Reserved parameter (not applicable).	Reserved parameter. Not applicable.
MaxGpuQuantity	integer	No	Reserved parameter (not applicable).	Reserved parameter. Not applicable.
TargetResourceGroupName	string	No	Reserved parameter (not applicable).	Reserved parameter. Not applicable.
Status	string	No	The resource group status. starting indicates that the resource group is being started. stopping indicates that the resource group is being stopped.	starting
RayConfig	object	No	The Ray configuration. This parameter is required when the resource group is an AI resource group and the corresponding engine is RayCluster.
EnableUserEni	boolean	No	Specifies whether to enable ENI.
HeadSpecType	string	No	The resource type of the head node.	CPU
HeadSpec	string	No	The specification of the head node.	xlarge
HeadAllocateUnit	string	No	The allocation unit of the head node.	1
HeadDiskCapacity	string	No	The disk size of the head node.	100G
Category	string	No	The Ray cluster type. Valid values: BASIC: basic type, non-high availability HIGH_AVAILABILITY: high availability type	BASIC
WorkerGroups	array<object>	No	The list of Ray worker group configurations.
	object	No	The Ray worker group configuration.
AllocateUnit	string	No	The allocation unit.	1
GroupName	string	No	The worker group name.	test
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 the worker node.	100G
WorkerSpecName	string	No	The specification of the worker node.	xlarge
WorkerSpecType	string	No	The resource type of the worker node.	GPU
AppConfig	object	No	The Ray application configuration.
AppName	string	No	The application name.	app01
AppType	string	No	The application type.	IsaacLab
ImageSelector	object	No	The image configuration.
Image	string	No	The image name.	lab2.10.0-ray2.43.0
InferenceEngine	string	No	The inference engine.	vLLM
LlmModel	string	No	The LLM model.	Deepseek-R1
StorageMounts	array<object>	No	The storage mount list.
	object	No	The storage mount.
StorageId	integer	No	The storage ID.	1
MountPath	string	No	The mount path.	/mnt/data01
StorageName	string	No
UserDefinedRequirements	string	No
GpuElasticPlan	object	No	The GPU time-sharing elastic plan.
Enabled	boolean	No	Specifies whether to enable the elastic plan immediately after creation. Valid values: true: Enables the plan immediately. false: Does not enable the plan.	true
Rules	array<object>	No	The list of rules.
	object	No	The rule.
StartCronExpression	string	No	The start time, specified as a cron expression. The interval must be at least 1 hour.	0 0 2 * * ?
EndCronExpression	string	No	The end time, specified as a cron expression. The interval must be at least 1 hour.	0 0 3 * * ?
AtmConfig	object	No	The PromQL resource group configuration.
SelectNodeSpec	string	No	The query node specification ([0-9+]ACU).	8ACU
SelectNodeNum	integer	No	The number of query nodes.	1
SelectNodeCacheSize	integer	No	The query node cache size in GB.	10
StorageNodeSpec	string	No	The storage node specification in [0-9+]ACU.	8ACU
StorageNodeNum	integer	No	The number of storage nodes.	2
StorageNodeDiskSize	integer	No	The storage node disk size.	1
StorageNodeDiskType	string	No	The storage node disk type (essd_pl1, essd_pl2).	essd_pl1
InsertNodeSpec	string	No	The insert node specification in [0-9+]ACU.	8ACU
InsertNodeNum	integer	No	The number of insert nodes.	2
AuthNodeSpec	string	No	The authentication node specification in [0-9+]ACU.	8ACU
AuthNodeNum	integer	No	The number of authentication nodes.	2

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	805F14E1-0186-520E-A6D5-30188D94E8DA

Examples

Success response

JSON format

{
  "RequestId": "805F14E1-0186-520E-A6D5-30188D94E8DA"
}

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.ElasticPlanExists	This resource group does not support this operation. Elastic plans that have been enabled already exist.	This operation is not supported for the current resource group because a scaling plan has been enabled.
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.