文档首页/ 云数据库 RDS/ API参考/ API v3（推荐）/ 实例管理/ 设置自动扩容策略
更新时间：2024-08-01 GMT+08:00
查看PDF
分享

设置自动扩容策略

功能介绍

设置实例存储空间自动扩容策略，按扩容量扣除存储费用。

可用存储空间小于等于设置值或者为10GB时，自动扩容当前存储空间的20%（如果是非10倍数则向上取整）。如果自定义了扩容步长，则按自定义的步长扩容，如需自定义扩容步长，请联系客服申请。

设置只读实例自动扩容与主实例自动扩容互不影响，对只读实例设置自动扩容时，可选择大于或等于主实例的存储空间。

调试

您可以在API Explorer中调试该接口。

接口约束

  • 账户余额必须大于等于0元，余额不足会导致自动扩容失败。
  • 该接口仅支持RDS for MySQL和RDS for PostgreSQL磁盘大小为40GB及以上的云盘实例（即存储类型为SSD云盘或极速型SSD）。
  • 实例在进行规格变更、内核小版本升级、备机迁移、重启时，不能进行自动扩容。
  • 包周期实例存在未完成订单时，不会自动扩容。
  • 实例状态为“正常”和“存储空间满”时可以进行扩容。最大可自动扩容至4000GB。

URI

  • URI格式

    PUT /v3/{project_id}/instances/{instance_id}/disk-auto-expansion

  • 参数说明
    表1 参数说明

    名称

    是否必选

    说明

    project_id

    是

    租户在某一Region下的项目ID。

    获取方法请参见获取项目ID。

    instance_id

    是

    实例ID。

请求消息

表2 参数说明

名称

是否必选

参数类型

说明

switch_option

是

Boolean

是否开启自动扩容。

  • true为开启。
  • false为关闭。

limit_size

否

Integer

扩容上限，单位GB。“switch_option”为true时，该参数必填。

取值范围40GB~4000GB，需要大于等于实例当前存储空间总大小。

trigger_threshold

否

Integer

可用存储空间百分比，小于等于此值或者为10GB时触发扩容。“switch_option”为true时，该参数必填。

枚举值：

  • 10
  • 15
  • 20

step_percent

否

Integer

每次自动扩容的步长，单位为百分比，即每次自动扩容当前存储空间的百分比。取值范围为5%~50%。

“switch_option”为true，且开启了自定义扩容步长功能时，该参数可选，不填时默认为20%。

请求示例

设置实例可用存储空间小于等于总空间10%或者为10GB时触发自动扩容，扩容上限为4000GB。 
PUT https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/3d39c18788b54a919bab633874c159dfin01/disk-auto-expansion
{
  "switch_option" : true,
  "limit_size" : 4000,
  "trigger_threshold" : 10
}
设置实例可用存储空间小于等于总空间10%或者为10GB时触发自动扩容，扩容上限为4000GB，每次自动扩容当前存储空间的20%。 
{
  "switch_option" : true,
  "limit_size" : 4000,
  "trigger_threshold" : 10,
  "step_percent" : 20
}

响应消息

状态码

错误码

请参见错误码。

父主题： 实例管理

相关文档