ModifyDBCluster-阿里云帮助中心

Operation description

Usage notes

During scaling, you cannot submit an asynchronous job by using the submit job command. If your business relies on this feature, we recommend that you scale the cluster during off-peak hours.
A scaling operation triggers data redistribution, and the migration time is proportional to the data volume. Service is not interrupted during scaling. When you scale down a cluster, data migration can take several hours or longer. Be cautious when you scale down clusters with large data volumes.
If a built-in dataset is loaded to the cluster, ensure that the cluster has at least 24 ACU of reserved storage resource when you scale it down. Otherwise, the built-in dataset becomes unavailable.
A transient connection failure may occur near the end of the scaling process. We recommend that you perform scaling during off-peak hours or ensure that your application has an automatic reconnection mechanism.
You cannot change a Data Lakehouse Edition cluster to a Data Warehouse Edition cluster. However, you can change a Data Warehouse Edition cluster to a Data Lakehouse Edition cluster. For more information, see Change a Data Warehouse Edition cluster to a Data Lakehouse Edition cluster.
For information about service endpoints, see Service 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:ModifyDBCluster

update

*DBClusterLakeVersion

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

None

Request parameters

Parameter	Type	Required	Description	Example
DBClusterId	string	Yes	The ID of the Data Lakehouse cluster. Note You can call the DescribeDBClusters operation to query the cluster ID.	amv-bp1r053byu48p****
RegionId	string	No	The region ID. Note You can call the DescribeRegions operation to query the region ID of the specified Data Lakehouse cluster.	cn-hangzhou
StorageResource	string	No	The reserved storage resource. Valid values: 0 to 2,064 ACU, in increments of 24. One ACU is approximately 1 core and 4 GB of memory. Note Include the unit in the value.	24ACU
ComputeResource	string	No	The reserved compute resource. Valid values: 0 to 4,096 ACU, in increments of 16. One ACU is approximately 1 core and 4 GB of memory. Note Include the unit in the value.	16ACU
EnableDefaultResourcePool	boolean	No	Specifies whether to allocate all reserved compute resources to the `user_default` default resource group. Valid values: true (Default) false	true
ProductForm	string	No	The product form. Valid values: IntegrationForm: integrated form. LegacyForm: Data Lakehouse Edition.	LegacyForm
ReservedNodeSize	string	No	The node specification for the reserved storage resource. Valid values: `8ACU`, `12ACU`, and `16ACU`. Note Include the unit in the value. This parameter is valid only when `ProductForm` is set to `IntegrationForm`.	8ACU
ReservedNodeCount	integer	No	The number of reserved nodes. For Enterprise Edition, the default value is 3, and the value must be in increments of 3. For Basic Edition, the default value is 1. Note This parameter is valid only when `ProductForm` is set to `IntegrationForm`.	3

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	0D6BF3E2-41D8-57F6-9A62-A13A70377952
DBClusterId	string	The cluster ID.	amv-bp1r053byu48p****
OrderId	string	The order ID.	2035629****

Examples

Success response

JSON format

{
  "RequestId": "0D6BF3E2-41D8-57F6-9A62-A13A70377952",
  "DBClusterId": "amv-bp1r053byu48p****",
  "OrderId": "2035629****"
}

Error codes

HTTP status code	Error code	Error message	Description
400	ACS.Cluster.InvalidWorkerState	The state of the worker does not support this operation.	This operation is not supported due to the current state of the storage node.
400	ACS.Cluster.ElasticPlanJobsExists	Operation failed. Ongoing elastic plan jobs exist.	Failed to perform this operation because a storage scaling plan job is running.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.