ModifyDBClusterShardNumber-阿里云帮助中心

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

update

*DBCluster

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

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID. Note You can call the DescribeRegions API to query the most recent list of regions.	cn-hangzhou
DBClusterId	string	Yes	The ID of the AnalyticDB for MySQL cluster. Note You can call the DescribeDBClusters API to query the IDs of all AnalyticDB for MySQL clusters in a specific region.	amv-bp1xxxxxxxx47
NewShardNumber	integer	No	The new number of shards.	256
SwitchTimeMode	integer	No	Specifies when to modify the number of shards. Valid values: Immediate: The modification takes effect immediately. This is the default value. MaintainTime: The modification takes effect during the cluster's maintenance window. You can call the ModifyDBInstanceMaintainTime API to change the maintenance window. ScheduleTime: The modification takes effect at a specified time. If you set this parameter to ScheduleTime, you must also specify the SwitchTime parameter.	Immediate
SwitchTime	string	No	The scheduled time to apply the modification. Specify the time 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 a dry run. Valid values: true: Sends a check request to verify prerequisites and the validity of the specified number of shards. The number of shards is not modified. false (default): Sends a standard request. After the request passes the check, the system triggers a backend task to modify the number of shards for the cluster.	false

Response elements

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

Examples

Success response

JSON format

{
  "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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.