# 按需转包周期（PostgreSQL） - UpdateToPeriod
#### 功能介绍
RDS实例按需转包周期接口。
- 调用接口前，您需要了解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://console.huaweicloud.com/apiexplorer/#/openapi/RDS/doc?api=UpdateToPeriod)中调试该接口。
#### 授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-rds/rds_10_0005.html)。
- 如果使用身份策略授权，需具备如下身份策略权限。
 
| 授权项                           | 访问级别  | 资源类型（\*为必须） | 条件键 | 别名                  | 依赖的授权项 |
|:---|:---|:---|:---|:---|:---|
| rds:instance:ondemandToPeriod | write | -           | -   | rds:instance:modify | -      |
   
#### 接口约束
该接口仅支持RDS for PostgreSQL引擎。
#### URI
- URI格式 POST /v3/{project_id}/instances/{instance_id}/to-period
  

- 参数说明
  表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参数说明 
  | 参数                | 是否必选 | 参数类型   | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
  |:---|:---|:---|:---|
  | period_type       | 是    | String | **参数解释：** 周期类型。 **约束限制：** 不涉及。 **取值范围：** - MONTH：月  - YEAR：年   **默认取值：** 不涉及。               |
  | period_num        | 是    | int    | **参数解释：** 周期数。 **约束限制**： 不涉及。 **取值范围**： - "period_type"为"MONTH"时，取值为1\~9的整数。  - "period_type"为"YEAR"时，取值为1\~3的整数。   **默认取值**： 不涉及。                                                                                                                |
  | auto_pay_policy   | 否    | String | **参数解释：** 是否自动支付。 **约束限制**： 不涉及。 **取值范围**： - YES：自动扣费  - NO：手动支付（默认）   **默认取值**： NO            |
  | auto_renew_policy | 否    | String | **参数解释：** 是否到期自动续期。 **约束限制**： 不涉及。 **取值范围**： - YES：自动续费  - NO：不自动续费（默认）   **默认取值**： NO |
     
  
- URI样例 POST https://rds.cn-north-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/49b9dd1d6f464ba4bc91df5cbd2e52ebin03/to-period
  
- 请求示例 RDS实例按需转包周期。
  ```
  { 
     "period_type" : "MONTH",
     "period_num" : 6,
     "auto_pay_policy" : "NO",
     "auto_renew_policy" : "NO"
   }
  ```
  
 
#### 响应消息
- 正常响应要素说明
  表3要素说明 
  | 名称       | 参数类型   | 说明                                                                                                                                                                                                                                              |
  |:---|:---|:---|
  | order_id | String | **参数解释**： 转包周期订单ID。 **取值范围：** 不涉及。 |
     
  

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