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

设置磁盘自动扩容策略

功能介绍

设置磁盘自动扩容策略。

接口约束

  • 包周期用户默认自动扣费，账户需要有足够的余额，才可进行自动扩容。
  • 有只读节点的副本集和集群实例不支持该操作。

URI

  • URI格式

    PUT https://{Endpoint}/v3/{project_id}/instances/auto-enlarge-volume-policies

  • URI样例

    https://dds.cn-north-1.myhuaweicloud.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/auto-enlarge-volume-policies

    表1 路径参数

    参数

    是否必选

    参数类型

    描述

    project_id

    是

    String

    参数解释：

    租户在某一Region下的项目ID。请参考获取项目ID章节获取项目编号。

    约束限制：

    不涉及。

    取值范围：

    不涉及。

    默认取值：

    不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

从IAM服务获取的用户Token。请参考认证鉴权。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。
表3 请求Body参数

名称

参数类型

是否必选

描述

switch_option

String

否

参数解释：

自动扩容开关。

约束限制：

不涉及。

取值范围：

  • on:开启磁盘自动扩容策略。
  • off: 关闭磁盘自动扩容策略。

默认取值：

默认值为on。

policies

Array of objects

是

参数解释：

磁盘自动扩容策略。

约束限制：

最大支持设置10个实例的策略。详情请参见表4。

取值范围：

不涉及。

默认取值：

不涉及。
表4 DiskAutoExpansionPolicy

名称

参数类型

是否必选

描述

instance_id

String

是

参数解释：

实例ID。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

threshold

Integer

否

参数解释：

触发自动扩容阈值，只支持输入80、85和90。默认阈值为90，即当已使用存储空间达到总存储空间的90%时就会触发扩容。集群实例的自动扩容阈值指的是每个shard。

约束限制：

只支持输入80、85和90。

取值范围：

80、85和90。

默认取值：

90。

step

Integer

否

参数解释：

扩容步长（s%），默认为10，支持输入10、15和20。当触发自动扩容的时候，自动扩容当前存储空间的s%（非10倍数向上取整。小数点后四舍五入，默认一次最小10G，账户余额不足时，会导致包年包月实例扩容失败）。

约束限制：

只支持输入10、15和20。

取值范围：

10、15和20。

默认取值：

10。

size

否

Integer

参数解释：

最大扩容上限，即当自动扩容达到上限后不再触发自动扩容。

约束限制：

必须为10的整数倍。

取值范围：

  • 最小值为当前实例的存储空间+10GB。
  • 实例规格小于8U时，自动扩容上限为5000GB。
  • 大于等于8U时，自动扩容上限为10000GB。

默认取值：

实例规格小于8U为5000GB，大于等于8U为10000GB。

响应参数

状态码： 400

表5 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：

错误码。

取值范围：

不涉及。

error_msg

String

参数解释：

错误消息。

取值范围：

不涉及。

状态码： 500

表6 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：

错误码。

取值范围：

不涉及。

error_msg

String

参数解释：

错误消息。

取值范围：

不涉及。

状态码： default

表7 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：

错误码。

取值范围：

不涉及。

error_msg

String

参数解释：

错误消息。

取值范围：

不涉及。

请求示例

打开ID为93e4b3eda14349b1b870f72829bc3b9bin02的实例自动扩容策略，触发自动扩容阈值为90%，扩容步长10%。

PUT https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/auto-enlarge-volume-policies

{ 
"switch_option" : "on",
"policies" : [ { 
  "instance_id" : "93e4b3eda14349b1b870f72829bc3b9bin02", 
  "threshold" : 90, 
  "step" : 10, 
  "size" : 3000 
 } ] 
}

关闭ID为93e4b3eda14349b1b870f72829bc3b9bin02的实例自动扩容策略。

PUT https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/auto-enlarge-volume-policies

{ 
  "policies" : [ { 
    "instance_id" : "93e4b3eda14349b1b870f72829bc3b9bin02" 
  } ], 
  "switch_option" : "off" 
}

响应示例

无。

状态码

状态码

描述

200

OK.

400

Client error.

500

Server error.

default

Client or server error.

错误码

详情请参见错误码。

父主题： 实例管理