Scale MySQL Cluster Capacity by Adjusting Shard Count - AnalyticDB

Changes the number of shards for an AnalyticDB for MySQL cluster.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
adb:ModifyDBClusterShardNumber	update	*DBCluster `acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}`	none	none

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID. Note You can call the DescribeRegions operation to query the most recent region list.	cn-hangzhou
DBClusterId	string	Yes	The ID of the AnalyticDB for MySQL Data Warehouse Edition cluster. Note You can call the DescribeDBClusters operation to query the information about all AnalyticDB for MySQL Data Warehouse Edition clusters within a region, including cluster IDs.	amv-bp1xxxxxxxx47
NewShardNumber	long	No	The desired number of shards.	256
SwitchTimeMode	long	No	The mode in which you want the change operation to be performed. Valid values: Immediate (default): immediately performs the change operation. MaintainTime: performs the change operation within the maintenance window of the cluster. You can call the ModifyDBInstanceMaintainTime operation to change the maintenance window. ScheduleTime: performs the change operation at the point in time that you specify. If you specify this value, you must also specify SwitchTime.	Immediate
SwitchTime	string	No	The point in time when you want the system to perform the change operation. Specify the time in the ISO 8601 standard in the `yyyy-MM-ddTHH:mm:ssZ` format. The time must be in UTC.	2021-07-09T22:00:00Z
DryRun	boolean	No	Specifies whether to perform only a dry run. Valid values: true: sends a request to check whether the cluster meets the prerequisites for changing the number of shards and whether the desired number of shards is valid, but does not perform the change operation. false (default): sends a request to perform a check and trigger the change operation.	false

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	25B56BC7-4978-40B3-9E48-4B7067******

Examples

Sample success responses

JSONformat

{
  "RequestId": "25B56BC7-4978-40B3-9E48-4B7067******"
}

Error codes

HTTP status code	Error code	Error message	Description
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.

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation

No change history