
# 设置自动扩容策略 - SetAutoEnlargePolicy
#### 功能介绍
设置实例存储空间自动扩容策略，按扩容量扣除存储费用。
可用存储空间小于等于设置值或者为10GB时，自动扩容当前存储空间的20%（如果是非10倍数则向上取整）。如果自定义了扩容步长，则按自定义的步长扩容，如需自定义扩容步长，请联系客服申请。
设置只读实例自动扩容与主实例自动扩容互不影响，对只读实例设置自动扩容时，可选择大于或等于主实例的存储空间。
- 调用接口前，您需要了解API[认证鉴权](https://support.huaweicloud.com/api-rds/rds_03_0001.html)。
- 调用接口前，您需要了解[请求Header参数说明](https://support.huaweicloud.com/api-rds/rds_03_0005.html#rds_03_0005__section479119143310)。
 
#### 调试
您可以在[API Explorer](https://apiexplorer.developer.huaweicloud.com/apiexplorer/doc?product=RDS&api=SetAutoEnlargePolicy)中调试该接口。
#### 授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-rds/rds_10_0005.html)。
- 如果使用身份策略授权，需具备如下身份策略权限。
 
| 授权项                               | 访问级别                  | 资源类型（\*为必须） | 条件键                                                                            | 别名                       | 依赖的授权项 |
|:---|:---|:---|:---|:---|:---|
| rds:instance:setAutoEnlargePolicy | permission_management | instance    | g:EnterpriseProjectId g:ResourceTag/\<tag-key\> | rds:instance:extendSpace | -      |
   
#### 接口约束
- 账户余额必须大于等于0元，余额不足会导致自动扩容失败。
- 该接口仅支持RDS for MySQL和RDS for PostgreSQL磁盘大小为40GB及以上的云盘实例（即存储类型为SSD云盘或极速型SSD）。
- 实例在进行规格变更、内核小版本升级、备机迁移、重启时，不能进行自动扩容。
- 包周期实例存在未完成订单时，不会自动扩容。
- 实例状态为"正常"和"存储空间满"时可以进行扩容。
 
#### URI
- URI格式 PUT /v3/{*project_id* }/instances/{*instance_id*}/disk-auto-expansion
  

- 参数说明
  表1参数说明 
  | 名称          | 是否必选 | 说明                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
  |:---|:---|:---|
  | project_id  | 是    | **参数解释：** 租户在某一region下的project ID。 获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-rds/rds_03_0002.html)。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。                                                                                 |
  | instance_id | 是    | **参数解释：** 实例ID。 可调用[查询数据库实例列表](https://support.huaweicloud.com/api-rds/rds_01_0004.html)接口，通过[表4](https://support.huaweicloud.com/api-rds/rds_01_0004.html#rds_01_0004__table2058713718267)中的"id"获取。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 |
     
  
 
#### 请求消息
表2参数说明 
| 名称                | 是否必选 | 参数类型    | 说明                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
|:---|:---|:---|:---|
| switch_option     | 是    | Boolean | **参数解释：** 是否开启自动扩容。 **约束限制**： 不涉及。 **取值范围**： - true为开启。  - false为关闭。   **默认取值**： 不涉及。                                                                                                       |
| limit_size        | 否    | Integer | **参数解释：** 扩容上限，单位GB。 **约束限制**： "switch_option"为true时，该参数必填。 **取值范围**： - 对于MySQL引擎：20GB\~10000GB，并且需要大于等于实例当前存储空间总大小。  - 对于PostgreSQL引擎：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
}
```
#### 响应消息
- 正常响应样例 无。
  
- 异常响应 请参见[异常响应结果](https://support.huaweicloud.com/api-rds/rds_01_0010.html)。
  
 
#### 状态码
- 正常 200
  
- 异常 请参见[状态码](https://support.huaweicloud.com/api-rds/rds_10_0200.html)。
  
 
#### 错误码
请参见[错误码](https://support.huaweicloud.com/api-rds/rds_10_0201.html)。
