
# 设置回收站策略 - StartRecyclePolicy
#### 功能介绍
设置回收站的回收策略。
- 调用接口前，您需要了解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=StartRecyclePolicy)中调试该接口。
#### 授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-rds/rds_10_0005.html)。
- 如果使用身份策略授权，需具备如下身份策略权限。
 
| 授权项                        | 访问级别  | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 |
|:---|:---|:---|:---|:---|:---|
| rds:instance:setRecycleBin | write | -           | -   | -  | -      |
   
#### URI
- URI格式 PUT /v3/{project_id}/instances/recycle-policy
  

- 参数说明
  表1参数说明 
  | 名称         | 是否必选 | 说明                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
  |:---|:---|:---|
  | project_id | 是    | **参数解释：** 租户在某一region下的project ID。 获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-rds/rds_03_0002.html)。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 |
     
  
 
#### 请求消息
表2参数说明 
| 名称             | 是否必选 | 参数类型   | 说明                                                                                                                                                                                                                   |
|:---|:---|:---|:---|
| recycle_policy | 是    | Object | **参数解释**： 每个元素都是与回收站相关信息。 每个元素结构请参见[表3]。 **约束限制**： 不涉及。 |
   
 表3recycle_policy元素说明 
| 名称                       | 是否必选 | 参数类型   | 说明                                                                                                                                                                                                                                                                                                                                          |
|:---|:---|:---|:---|
| retention_period_in_days | 否    | String | **参数解释**： 保留时间，设置已删除实例保留天数。 **约束限制**： 不涉及。 **取值范围**： 支持整数，可设置范围为1\~7天。 **默认取值**： 当"retention_period_in_days"为空，保留时间默认是7天。 |
   
#### 请求示例
设置回收站的保留天数为1天。
```
PUT https://{endpoint}/v3/054ea741f700d4a32f1bc00f5c80dd4c/instances/recycle-policy
{
     "recycle_policy":{
                 "retention_period_in_days":"1"
               }
}
```
#### 响应消息
- 正常响应要素说明
  表4要素说明 
  | 名称     | 参数类型   | 说明                                                                                                                                |
  |:---|:---|:---|
  | result | String | **参数解释**： 调用结果。 **取值范围**： success：调用正常。 |
     
  

- 正常响应样例
  ```
  {
  "result": "success"
  }
  ```
  
 
- 异常响应 请参见[异常响应结果](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)。
