Modifies the elastic scaling configuration of an instance.
Operation description
This API operation allows you to modify the Automatic storage scaling, automatic storage expansion, bandwidth elastic scaling, and resource elastic scaling features of a database instance:
-
You can modify the specification elastic scaling feature for the following database instances:
PolarDB for MySQL Cluster Edition. For feature introduction and billing information, see automatic scaling for performance optimization.
ApsaraDB RDS for MySQL high availability series cloud disk edition. For feature introduction and billing information, see automatic scaling for performance optimization.
Tair (Redis® OSS-Compatible) cloud-native (formerly cloud disk) open-source edition. For feature introduction and billing information, see Enable automatic scaling.
-
You can modify the automatic storage expansion feature for the following database instances:
ApsaraDB RDS for MySQL high availability series cloud disk instance. For feature introduction and billing information, see automatic space expansion.
-
You can modify the bandwidth elastic scaling feature for the following database instances:
Tair (Redis® OSS-Compatible) classic (formerly local disk) instances. For feature introduction and billing information, see Automatic bandwidth adjustment.
-
You can modify the shard elastic scaling feature for the following database instances:
Tair (Redis® OSS-Compatible) cloud-native (formerly cloud disk) open-source edition in cluster architecture. For feature introduction and billing information, see Automatic shard addition.
-
You can modify the resource elastic scaling feature for the following database instances:
ApsaraDB RDS for MySQL high availability series local disk edition (general-purpose) and RDS Enterprise Edition (general-purpose). For feature introduction and billing information, see automatic scaling for performance optimization.
-
Use the latest version of the Alibaba Cloud or DAS SDK.
-
When you use the SDK to call DAS, set the region to cn-shanghai.
-
You can modify the specification elastic scaling feature for the following database instances:
PolarDB for MySQL Cluster Edition. For feature introduction and billing information, see automatic scaling for performance optimization.
ApsaraDB RDS for MySQL high availability series cloud disk edition. For feature introduction and billing information, see automatic scaling for performance optimization.
-
You can modify the automatic storage expansion feature for the following database instances:
ApsaraDB RDS for MySQL high availability series cloud disk instance. For feature introduction and billing information, see automatic space expansion.
-
You can modify the bandwidth elastic scaling feature for the following database instances:
Tair (Redis® OSS-Compatible) classic (formerly local disk) instances. For feature introduction and billing information, see Automatic bandwidth adjustment.
-
You can modify the resource elastic scaling feature for the following database instances:
RDS Enterprise Edition (general-purpose). For feature introduction and billing information, see automatic scaling for performance optimization.
-
Use the latest version of the Alibaba Cloud or DAS SDK.
-
When you use the SDK to call DAS, set the region to cn-shanghai.
Try it now
Test
RAM authorization
|
Action |
Access level |
Resource type |
Condition key |
Dependent action |
|
hdm:ModifyAutoScalingConfig |
update |
*All Resource
|
None | None |
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| InstanceId |
string |
Yes |
The instance ID. |
rm-2ze8g2am97624**** |
| Spec |
object |
No |
The configuration items for the specification elastic scaling feature. |
|
| Apply |
boolean |
No |
Specifies whether to apply the configurations under the Spec configuration item for the specification elastic scaling feature:
|
true |
| Upgrade |
boolean |
No |
Specifies whether to enable automatic specification scale-up:
|
true |
| CpuUsageUpperThreshold |
integer |
No |
The threshold of average CPU utilization that triggers automatic specification scale-up. Unit: %. Valid values:
Important You must set this parameter when the target database instance is PolarDB for MySQL Cluster Edition or ApsaraDB RDS for MySQL high availability series cloud disk edition.
Valid values:
|
70 |
| MemUsageUpperThreshold |
integer |
No |
The threshold of average memory utilization that triggers automatic specification scale-up. Unit: %. Valid values:
Important You must set this parameter when the target database instance is Tair (Redis® OSS-Compatible) cloud-native (formerly cloud disk) open-source edition on the China site.
Valid values:
|
70 |
| MaxSpec |
string |
No |
The upper limit of the specification for automatic scale-up. You can only scale up to a higher specification within the same series of the database instance. For more details, see the specification documentation for each database instance:
|
polar.mysql.x8.12xlarge |
| MaxReadOnlyNodes |
integer |
No |
The maximum number of read-only nodes for the instance. Important You must set this parameter when the target database instance is PolarDB for MySQL Cluster Edition.
|
10 |
| ObservationWindowSize |
string |
No |
The observation window. The parameter value consists of a number and a time unit suffix. The supported database instances and valid values are as follows. The time suffix m indicates minutes, and h indicates hours:
|
5m |
| CoolDownTime |
string |
No |
The cool-down period. The parameter value consists of a number and a time unit suffix. The supported database instances and valid values are as follows. The time suffix m indicates minutes, h indicates hours, and d indicates days:
|
5m |
| Downgrade |
boolean |
No |
Specifies whether automatic specification scale-down is enabled:
Important You must set this parameter when the target database instance is PolarDB for MySQL Cluster Edition or ApsaraDB RDS for MySQL high availability series cloud disk edition.
|
true |
| Storage |
object |
No |
The configuration items for the automatic storage expansion feature. |
|
| Apply |
boolean |
No |
Specifies whether to apply the configurations under the Storage configuration item for the automatic storage expansion feature:
|
true |
| Upgrade |
boolean |
No |
Specifies whether to enable automatic storage expansion:
|
true |
| DiskUsageUpperThreshold |
integer |
No |
The threshold of average storage space utilization that triggers automatic storage expansion. Unit: %. Valid values:
Valid values:
|
70 |
| MaxStorage |
integer |
No |
The upper limit of the storage space. The value must be greater than or equal to the current total storage space of the instance. Valid values:
Note
Standard SSDs are retired. Upgrade to ESSD cloud disks. |
32000 |
| Bandwidth |
object |
No |
The configuration items for the bandwidth elastic scaling feature. |
|
| Apply |
boolean |
No |
Specifies whether to apply the configurations under the Bandwidth configuration item for the bandwidth elastic scaling feature:
|
true |
| Upgrade |
boolean |
No |
Specifies whether to enable automatic bandwidth upgrade:
|
true |
| BandwidthUsageUpperThreshold |
integer |
No |
The threshold of average bandwidth usage that triggers automatic bandwidth upgrade. Unit: %. Valid values:
|
70 |
| ObservationWindowSize |
string |
No |
The observation window for automatic bandwidth upgrade. The parameter value consists of a number and a time unit suffix. The time suffix m indicates minutes. Valid values:
Valid values:
|
5m |
| Downgrade |
boolean |
No |
Specifies whether to enable automatic bandwidth downgrade:
|
true |
| BandwidthUsageLowerThreshold |
integer |
No |
The threshold of average bandwidth usage that triggers automatic bandwidth downgrade. Unit: %. Valid values:
|
30 |
| Shard |
object |
No |
The configuration items for the shard elastic scaling feature. |
|
| Apply |
boolean |
No |
Specifies whether to apply the configurations under the Shard configuration item for the shard elastic scaling feature:
Important The shard elastic scaling feature is supported only when the target database instance is Tair (Redis® OSS-Compatible) cloud-native (formerly cloud disk) edition in cluster architecture on the China site.
|
true |
| Upgrade |
boolean |
No |
Specifies whether to enable automatic shard addition:
|
true |
| MemUsageUpperThreshold |
integer |
No |
The threshold of average memory utilization that triggers automatic shard addition. Unit: %. Valid values:
Valid values:
|
70 |
| MaxShards |
integer |
No |
The maximum total number of shards for the instance. The value must be a positive integer. Valid values: 4 to 32. |
16 |
| UpgradeObservationWindowSize |
string |
No |
The observation window for automatic shard addition. The parameter value consists of a number and a time unit suffix. The time suffix m indicates minutes. Valid values:
Valid values:
|
5m |
| Downgrade |
boolean |
No |
Specifies whether to enable automatic shard reduction:
Note
The automatic shard reduction feature is currently in canary release. |
true |
| MemUsageLowerThreshold |
integer |
No |
The threshold of average memory utilization that triggers automatic shard reduction. Unit: %. Valid values:
Valid values:
|
30 |
| MinShards |
integer |
No |
The minimum total number of shards for the instance. The value must be a positive integer. Valid values: 4 to 32. |
4 |
| DowngradeObservationWindowSize |
string |
No |
The observation window for automatic shard reduction. The parameter value consists of a number and a time unit suffix. The time suffix h indicates hours, and d indicates days. Valid values:
Valid values:
|
1h |
| Resource |
object |
No |
The configuration items for the resource elastic scaling feature. |
|
| Apply |
boolean |
No |
Specifies whether to apply the configurations under the Resource configuration item for the resource elastic scaling feature:
|
true |
| Enable |
boolean |
No |
Specifies whether to enable resource elastic scaling:
|
true |
| CpuUsageUpperThreshold |
integer |
No |
The threshold of average CPU utilization that triggers automatic resource scale-up. Unit: %. Valid values:
Valid values:
|
70 |
| UpgradeObservationWindowSize |
string |
No |
The observation window for scale-up. The parameter value consists of a number and a time unit suffix. The time suffix m indicates minutes. Valid values:
Valid values:
|
5m |
| DowngradeObservationWindowSize |
string |
No |
The observation window for scale-down. The parameter value consists of a number and a time unit suffix. The time suffix m indicates minutes. Valid values:
Valid values:
|
5m |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
|||
| Code |
string |
The returned status code. |
200 |
| Message |
string |
The returned message. Note
If the request is successful, Successful is returned. If the request fails, an error message such as an error code is returned. |
Successful |
| RequestId |
string |
The request ID. |
B6D17591-B48B-4D31-9CD6-9B9796B2**** |
| Success |
string |
Indicates whether the request was successful:
|
true |
Examples
Success response
JSON format
{
"Code": "200",
"Message": "Successful",
"RequestId": "B6D17591-B48B-4D31-9CD6-9B9796B2****",
"Success": "true"
}
Error codes
|
HTTP status code |
Error code |
Error message |
Description |
|---|---|---|---|
| 400 | InvalidParams | The request parameters are invalid. | The request parameters are invalid. |
| 403 | NoPermission | You are not authorized to do this action. | You do not have the permission to perform this operation. |
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.