ModifyAutoScalingConfig - 修改实例弹性伸缩功能配置

更新时间:
复制为 MD 格式

调用ModifyAutoScalingConfig接口,修改实例弹性伸缩功能配置。

接口说明

API 支持修改数据库实例的规格弹性伸缩功能、存储自动扩容功能、带宽弹性伸缩功能、分片弹性伸缩功能以及资源弹性伸缩功能:

  • 以下目标数据库实例支持修改规格弹性伸缩功能:

    • PolarDB MySQL 版的集群版,功能介绍及费用说明参见自动性能扩展

    • RDS MySQL 高可用系列云盘版,功能介绍及费用说明参见自动性能扩展

    • Redis 云原生(原云盘)开源版,功能介绍及费用说明参见开启自动扩容

  • 以下目标数据库实例支持修改存储自动扩容功能:

    • RDS MySQL 高可用系列云盘实例,功能介绍及费用说明参见自动空间扩展

  • 以下目标数据库实例支持修改带宽弹性伸缩功能:

    • Redis 经典(原本地盘)实例,功能介绍及费用说明参见自动调整带宽

  • 以下目标数据库实例支持修改分片弹性伸缩功能:

    • Redis 云原生(原云盘)开源版集群架构,功能介绍及费用说明参见自动增加分片

  • 以下目标数据库实例支持修改资源弹性伸缩功能:

    • RDS MySQL 高可用系列本地盘版(通用型)和三节点企业系列(通用型),功能介绍及费用说明参见自动性能扩展

  • 使用阿里云或 DAS 的 SDK 时,建议使用最新版本。

  • 在使用 SDK 调用 DAS 服务时,需要将地域指定为 cn-shanghai。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

hdm:ModifyAutoScalingConfig

update

*全部资源

*

请求参数

名称

类型

必填

描述

示例值

InstanceId

string

实例 ID。

rm-2ze8g2am97624****

Spec

object

规格弹性伸缩功能配置项。

Apply

boolean

是否应用规格弹性伸缩功能配置项 Spec 下的配置:

  • true:是。

  • false:否。

true

Upgrade

boolean

是否开启规格自动扩容:

  • true:是。

  • false:否。

true

CpuUsageUpperThreshold

integer

触发规格自动扩容的 CPU 平均利用率阈值,单位为%,取值:

  • 50

  • 60

  • 70

  • 80

  • 90

重要 目标数据库实例为 PolarDB MySQL 版的集群版、RDS MySQL 高可用系列云盘版时,需要设置本参数。

70

MemUsageUpperThreshold

integer

触发规格自动扩容的内存平均利用率阈值,单位为%,取值:

  • 50

  • 60

  • 70

  • 80

  • 90

重要 目标数据库实例为中国站 Redis 云原生(原云盘)开源版时,需要设置本参数。

70

MaxSpec

string

自动扩容的规格上限。仅支持扩容到数据库实例同系列的更高规格,详情请参见各数据库实例的产品规格文档:

polar.mysql.x8.12xlarge

MaxReadOnlyNodes

integer

实例只读节点数的最大值。

重要 目标数据库实例为 PolarDB MySQL 版的集群版时,需要设置本参数。

10

ObservationWindowSize

string

观测窗口。参数值由数值和时间单位后缀组成,支持的数据库实例及其取值如下,其中时间后缀 m 表示分钟,h 表示小时:

  • PolarDB MySQL 版的集群版:5m10m15m30m

  • RDS MySQL 高可用系列云盘版:5m20m30m40m1h

  • Redis 云原生(原云盘)开源版:5m10m15m30m

5m

CoolDownTime

string

静默期。参数值由数值和时间单位后缀组成,支持的数据库实例及其取值如下,其中时间单位后缀 m 表示分钟,h 表示小时,d:表示天:

  • PolarDB MySQL 版的集群版:5m10m30m1h2h3h1d7d

  • RDS MySQL 高可用系列云盘版:5m10m30m1h2h3h1d7d

5m

Downgrade

boolean

是否开启规格自动回缩:

  • true:是。

  • false:否。

重要 目标数据库实例为 PolarDB MySQL 版的集群版、RDS MySQL 高可用系列云盘版时,需要设置本参数。

true

Storage

object

存储自动扩容功能配置项。

Apply

boolean

是否应用存储自动扩容功能配置项 Storage 下的配置:

  • true:是。

  • false:否。

true

Upgrade

boolean

是否开启存储自动扩容:

  • true:是。

  • false:否。

true

DiskUsageUpperThreshold

integer

触发存储自动扩容的存储空间平均利用率阈值,单位为%,取值:

  • 50

  • 60

  • 70

  • 80

  • 90

70

MaxStorage

integer

存储空间上限,需要大于等于实例当前存储空间总大小,取值:

  • ESSD 云盘上限:32000 GB。

  • SSD 云盘上限:6000 GB。

说明

SSD 云盘已下线,建议升级至 ESSD 云盘

32000

Bandwidth

object

带宽弹性伸缩功能配置项。

Apply

boolean

是否应用带宽弹性伸缩功能配置项 Bandwidth 下的配置:

  • true:是。

  • false:否。

true

Upgrade

boolean

是否开启带宽自动扩展:

  • true:是。

  • false:否。

true

BandwidthUsageUpperThreshold

integer

触发带宽自动扩展的带宽平均使用率阈值,单位为%,取值:

  • 50

  • 60

  • 70

  • 80

  • 90

  • 95

70

ObservationWindowSize

string

带宽自动扩展的观测窗口。参数值由数值和时间单位后缀组成,其中时间单位后缀 m 表示分钟:

  • 1m

  • 5m

  • 10m

  • 15m

  • 30m

5m

Downgrade

boolean

是否开启带宽自动回缩:

  • true:是。

  • false:否。

true

BandwidthUsageLowerThreshold

integer

触发带宽自动回缩的带宽平均使用率阈值,单位为%,取值:

  • 10

  • 20

  • 30

30

Shard

object

分片弹性伸缩功能配置项。

Apply

boolean

是否应用分片弹性伸缩功能配置项 Shard 下的配置:

  • true:是。

  • false:否。

重要 仅当目标数据库实例为中国站 Redis 云原生(原云盘)版集群架构时,支持分片弹性伸缩功能。

true

Upgrade

boolean

是否开启自动增加分片:

  • true:是。

  • false:否。

true

MemUsageUpperThreshold

integer

触发自动增加分片的内存平均利用率阈值,单位为%,取值:

  • 50

  • 60

  • 70

  • 80

  • 90

70

MaxShards

integer

实例总分片数的最大值, 取值为正整数,取值范围:4~32。

16

UpgradeObservationWindowSize

string

自动增加分片观测窗口。参数值由数值和时间单位后缀组成,其中时间单位后缀 m 表示分钟:

  • 5m

  • 10m

  • 15m

  • 30m

5m

Downgrade

boolean

自动减少分片是否开启:

  • true:是。

  • false:否。

说明

自动减少分片功能目前在灰度发布中。

true

MemUsageLowerThreshold

integer

触发自动减少分片的内存平均利用率阈值,单位为%,取值:

  • 10

  • 20

  • 30

30

MinShards

integer

实例总分片数的最小值,取值为正整数,取值范围:4~32。

4

DowngradeObservationWindowSize

string

自动减少分片观测窗口,参数由数值和时间单位后缀组成,其中时间单位后缀 h 表示小时,d 表示天:

  • 1h

  • 2h

  • 3h

  • 1d

  • 7d

1h

Resource

object

资源弹性伸缩功能配置项。

Apply

boolean

是否应用资源弹性伸缩功能配置项 Resource 下的配置:

  • true:是。

  • false:否。

true

Enable

boolean

是否开启资源弹性伸缩:

  • true:是。

  • false:否。

true

CpuUsageUpperThreshold

integer

触发资源自动扩容的 CPU 平均利用率阈值,单位为%,取值:

  • 70

  • 80

  • 90

70

UpgradeObservationWindowSize

string

扩容观测窗口。参数值由数值和时间单位后缀组成,其中时间单位后缀 m 表示分钟:

  • 1m

  • 3m

  • 5m

  • 10m

  • 20m

  • 30m

枚举值:

  • 30m :

    30m

  • 5m :

    5m

  • 3m :

    3m

  • 1m :

    1m

  • 10m :

    10m

  • 20m :

    20m

5m

DowngradeObservationWindowSize

string

缩容观测窗口。参数值由数值和时间单位后缀组成,其中时间单位后缀 m 表示分钟:

  • 1m

  • 3m

  • 5m

  • 10m

  • 20m

  • 30m

5m

返回参数

名称

类型

描述

示例值

object

Code

string

返回的状态码。

200

Message

string

请求返回消息。

说明

请求成功时该参数返回 Successful,请求失败时会返回请求异常信息(如错误码等)。

Successful

RequestId

string

请求 ID。

B6D17591-B48B-4D31-9CD6-9B9796B2****

Success

string

请求是否执行成功:

  • true:执行成功。

  • false:执行失败。

true

示例

正常返回示例

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. 没有权限执行该操作

访问错误中心查看更多错误码。

变更历史

更多信息,参考变更详情