ModifyDBResourceGroup-阿里云帮助中心

Modify a cluster's resource group.

Operation description

For 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: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 Enterprise Edition, Basic Edition, or Data Lakehouse Edition cluster.	amv-bp1r053byu48p****
GroupName	string	Yes	The name of the resource group. Note You can call the DescribeDBResourceGroup operation to query the name of the resource group for a specified cluster.	test
GroupType	string	Yes	The type of the resource group. Valid values: Interactive Job Note For more information about resource groups for Data Lakehouse Edition, see Resource groups.	Interactive
MinComputeResource	string	No	The minimum reserved computing resources. If the resource group type is `Interactive`, the minimum value is 16 ACU. If the resource group type is `Job`, the minimum value is 0 ACU.	0ACU
MaxComputeResource	string	No	The maximum reserved computing resources. For an `Interactive` resource group, the maximum value is the unallocated resources in the cluster, in increments of 16 ACU. For a `Job` resource group, the maximum value is the unallocated resources in the cluster, in increments of 8 ACU.	48ACU
ClusterSizeResource	string	No	This parameter is reserved.	N/A
MinClusterCount	integer	No	This parameter is reserved.	N/A
MaxClusterCount	integer	No	This parameter is reserved.	N/A
ClusterMode	string	No	This parameter is reserved.	N/A
EnableSpot	boolean	No	Specifies whether to enable the spot instance feature. Spot instances have a lower resource unit price but may be reclaimed. 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 You can call the DescribeRegions operation to query the available regions and their IDs.	cn-hangzhou
Rules	array<object>	No	The job submission rules.
	object	No	A job submission rule.
GroupName	string	No	The name of the resource group.	user_default
QueryTime	string	No	The query execution time threshold, in milliseconds (ms). Queries that exceed this execution time are routed to the target resource group.	180000
TargetGroupName	string	No	The name of the target resource group.	job
EngineParams	object	No	The engine configuration.	{\"spark.adb.version\":\"3.5\"}
AutoStopInterval	string	No	The auto-stop interval. The system automatically stops the resource group if it is idle for this duration.	5m
SpecName	string	No	This parameter is reserved.	N/A
MinGpuQuantity	integer	No	This parameter is reserved.	N/A
MaxGpuQuantity	integer	No	This parameter is reserved.	N/A
TargetResourceGroupName	string	No	This parameter is reserved.	N/A
Status	string	No	The state of the resource group. Specify starting to start the resource group or stopping to stop the resource group.	starting
RayConfig	object	No	The Ray configuration. This parameter is required for AI resource groups that use the RayCluster engine.
EnableUserEni	boolean	No	Specifies whether to enable ENI.
HeadSpecType	string	No	The resource type of the head node.	CPU
HeadSpec	string	No	The specifications 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`: A standard cluster that does not provide high availability. `HIGH_AVAILABILITY`: A cluster that provides high availability.	BASIC
WorkerGroups	array<object>	No	A list of Ray worker group configurations.
	object	No	The configuration of a Ray worker group.
AllocateUnit	string	No	The allocation unit.	1
GroupName	string	No	The name of the worker group.	test
MaxWorkerQuantity	integer	No	The maximum number of worker nodes.	2
MinWorkerQuantity	integer	No	The minimum number of worker nodes.	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
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 large language model (LLM).	Deepseek-R1
StorageMounts	array<object>	No	A list of storage mounts.
	object	No	The storage mount.
StorageId	integer	No	The storage ID.	1
MountPath	string	No	The mount path.	/mnt/data01
UserDefinedRequirements	string	No
GpuElasticPlan	object	No	The GPU time-based scaling plan.
Enabled	boolean	No	Specifies whether to enable the scaling plan upon creation. Valid values: true: The plan is enabled upon creation. false: The plan is created but remains disabled.	true
Rules	array<object>	No	A list of rules.
	object	No	A rule.
StartCronExpression	string	No	The start time for the scaling rule, specified as a cron expression. The minimum scaling duration is 1 hour.	0 0 2 * * ?
EndCronExpression	string	No	The end time for the scaling rule, specified as a cron expression. The minimum scaling duration is 1 hour.	0 0 3 * * ?

Response elements

Element	Type	Description	Example
	object
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.