调用ModifyAutoScalingConfig接口,修改实例弹性伸缩功能配置。
接口说明
API 支持修改数据库实例的规格弹性伸缩功能、存储自动扩容功能、带宽弹性伸缩功能以及资源弹性伸缩功能:
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
InstanceId | string | 是 | 实例 ID。 | rm-2ze8g2am97624**** |
Spec | object | 否 | 规格弹性伸缩功能配置项。 | |
Apply | boolean | 否 | 是否应用规格弹性伸缩功能配置项 Spec 下的配置:
| true |
Upgrade | boolean | 否 | 是否开启规格自动扩容:
| true |
CpuUsageUpperThreshold | integer | 否 | 触发规格自动扩容的 CPU 平均利用率阈值,单位为%,取值:
注意 目标数据库实例为 PolarDB MySQL 版的集群版、RDS MySQL 高可用系列云盘版时,需要设置本参数。
| 70 |
MemUsageUpperThreshold | integer | 否 | 触发规格自动扩容的内存平均利用率阈值,单位为%,取值:
注意 目标数据库实例为中国站 Redis 云原生(原云盘)社区版时,需要设置本参数。
| 70 |
MaxSpec | string | 否 | polar.mysql.x8.12xlarge | |
MaxReadOnlyNodes | integer | 否 | 实例只读节点数的最大值。 注意 目标数据库实例为 PolarDB MySQL 版的集群版时,需要设置本参数。
| 10 |
ObservationWindowSize | string | 否 | 观测窗口。参数值由数值和时间单位后缀组成,支持的数据库实例及其取值如下,其中时间后缀 m 表示分钟,h 表示小时:
| 5m |
CoolDownTime | string | 否 | 静默期。参数值由数值和时间单位后缀组成,支持的数据库实例及其取值如下,其中时间单位后缀 m 表示分钟,h 表示小时,d:表示天:
| 5m |
Downgrade | boolean | 否 | 是否开启规格自动回缩:
注意 目标数据库实例为 PolarDB MySQL 版的集群版、RDS MySQL 高可用系列云盘版时,需要设置本参数。
| true |
Storage | object | 否 | 存储自动扩容功能配置项。 | |
Apply | boolean | 否 | 是否应用存储自动扩容功能配置项 Storage 下的配置:
| true |
Upgrade | boolean | 否 | 是否开启存储自动扩容:
| true |
DiskUsageUpperThreshold | integer | 否 | 触发存储自动扩容的存储空间平均利用率阈值,单位为%,取值:
| 70 |
MaxStorage | integer | 否 | 32000 | |
Bandwidth | object | 否 | 带宽弹性伸缩功能配置项。 | |
Apply | boolean | 否 | 是否应用带宽弹性伸缩功能配置项 Bandwidth 下的配置:
| true |
Upgrade | boolean | 否 | 是否开启带宽自动扩展:
| true |
BandwidthUsageUpperThreshold | integer | 否 | 触发带宽自动扩展的带宽平均使用率阈值,单位为%,取值:
| 70 |
ObservationWindowSize | string | 否 | 带宽自动扩展的观测窗口。参数值由数值和时间单位后缀组成,其中时间单位后缀 m 表示分钟:
| 5m |
Downgrade | boolean | 否 | 是否开启带宽自动回缩:
| true |
BandwidthUsageLowerThreshold | integer | 否 | 触发带宽自动回缩的带宽平均使用率阈值,单位为%,取值:
| 30 |
Shard | object | 否 | 分片弹性伸缩功能配置项。 | |
Apply | boolean | 否 | 是否应用分片弹性伸缩功能配置项 Shard 下的配置:
注意 仅当目标数据库实例为中国站 Redis 云原生(原云盘)版集群架构时,支持分片弹性伸缩功能。
| true |
Upgrade | boolean | 否 | 是否开启自动增加分片:
| true |
MemUsageUpperThreshold | integer | 否 | 触发自动增加分片的内存平均利用率阈值,单位为%,取值:
| 70 |
MaxShards | integer | 否 | 实例总分片数的最大值, 取值为正整数,取值范围:4~32。 | 16 |
UpgradeObservationWindowSize | string | 否 | 自动增加分片观测窗口。参数值由数值和时间单位后缀组成,其中时间单位后缀 m 表示分钟:
| 5m |
Downgrade | boolean | 否 | 自动减少分片是否开启:
说明
自动减少分片功能目前在灰度发布中。
| true |
MemUsageLowerThreshold | integer | 否 | 触发自动减少分片的内存平均利用率阈值,单位为%,取值:
| 30 |
MinShards | integer | 否 | 实例总分片数的最小值,取值为正整数,取值范围:4~32。 | 4 |
DowngradeObservationWindowSize | string | 否 | 自动减少分片观测窗口,参数由数值和时间单位后缀组成,其中时间单位后缀 h 表示小时,d 表示天:
| 1h |
Resource | object | 否 | 资源弹性伸缩功能配置项。 | |
Apply | boolean | 否 | 是否应用资源弹性伸缩功能配置项 Resource 下的配置:
| true |
Enable | boolean | 否 | 是否开启资源弹性伸缩:
| true |
CpuUsageUpperThreshold | integer | 否 | 触发资源自动扩容的 CPU 平均利用率阈值,单位为%,取值:
| 70 |
UpgradeObservationWindowSize | string | 否 | 扩容观测窗口。参数值由数值和时间单位后缀组成,其中时间单位后缀 m 表示分钟:
| 5m |
DowngradeObservationWindowSize | string | 否 | 缩容观测窗口。参数值由数值和时间单位后缀组成,其中时间单位后缀 m 表示分钟:
| 5m |
返回参数
示例
正常返回示例
JSON
格式
{
"Code": "200",
"Message": "Successful",
"RequestId": "B6D17591-B48B-4D31-9CD6-9B9796B2****",
"Success": "true"
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | InvalidParams | The request parameters are invalid. | 请求参数错误 |
403 | NoPermission | You are not authorized to do this action. | 没有权限执行该操作 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 | ||||
---|---|---|---|---|---|---|
2024-02-22 | OpenAPI 错误码发生变更 | 看变更集 | ||||
|