# 按需转包周期 - ChangingtheBillingModefromPay-per-UsetoYearly/Monthly #### 功能介绍 将按需计费的实例转为包周期计费。 - 调用接口前，您需要了解API [认证鉴权](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_011.html)。 - 调用接口前，您需要提前获取到[地区和终端节点](https://developer.huaweicloud.com/endpoint)。 #### 调试 您可以在[API Explorer](https://apiexplorer.developer.huaweicloud.com/apiexplorer/doc?product=GaussDBforopenGauss&api=ChangeDemand2Period)中调试该接口。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_189.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | gaussdb:instance:changeDemandToPeriod | ReadWrite | instance | - | gaussdb:instance:changeDemandToPeriod | - | #### URI PUT /v3/{project_id}/instances/change-charge-mode 表1参数说明 | 名称 | 是否必选 | 参数类型 | 说明 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释：** 租户在某一Region下的项目ID。 获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_196.html)。 **约束限制：** 不涉及。 **取值范围：** 只能由英文字母、数字组成，且长度为32个字符。 **默认取值**： 不涉及。 | #### 请求参数 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释：** 用户Token。 通过调用IAM服务[获取用户Token](https://support.huaweicloud.com/api-iam/iam_30_0001.html)接口获取。 请求响应成功后在响应消息头中包含的"X-Subject-Token"的值即为Token值。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值** **：** 不涉及。 | | X-Language | 否 | String | **参数解释：** 指定接口返回信息的语言类型。 **约束限制：** 不涉及。 **取值范围：** - **zh-cn**：中文 - **en-us**：英文 **默认取值** **：** **en-us** | 表3参数说明 | 名称 | 是否必选 | 参数类型 | 说明 | |:---|:---|:---|:---| | entity_ids | 是 | Array of strings | **参数解释** **：** 需要转成包周期计费模式的实例ID列表。获取方式请参考[查询数据库实例列表 - QueryingDBInstances](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_328.html)。 **约束限制** **：** 不涉及。 | | charge_info | 是 | Object | **参数解释** **：** 包周期相关信息。详见[表4]。 **约束限制** **：** 不涉及。 | 表4charge_info字段数据结构说明 | 名称 | 是否必选 | 参数类型 | 说明 | |:---|:---|:---|:---| | period_type | 是 | String | **参数解释** **：** 周期单位类型。 **约束限制** **：** 不涉及。 **取值范围** **：** - year：包年。 - month：包月。 **默认取值** **：** 不涉及。 | | period_num | 是 | Integer | **参数解释** **：** 周期单位数量。 **约束限制** **：** 不涉及。 **取值范围** **：** - 当"period_type"为"month"时，取值为1\~9。 - 当"period_type"为"year"时，取值为1\~3。 当传入浮点型时，会自动截取为整型。 **默认取值** **：** 不涉及。 | | is_auto_renew | 否 | Boolean | **参数解释** **：** 是否自动续费。 **约束限制** **：** 不涉及。 **取值范围** **：** - true：自动续订。 - false：不自动续订。 **默认取值** **：** false | | is_auto_pay | 否 | Boolean | **参数解释** **：** 是否自动支付。 **约束限制** **：** 不涉及。 **取值范围** **：** - true：自动支付。 - false：手动支付。 **默认取值** **：** false | #### 响应参数 表5参数说明 | 名称 | 参数类型 | 说明 | |:---|:---|:---| | order_ids | Array of strings | **参数解释** **：** 订单ID的集合。 | #### 请求示例 按需计费的实例转为包周期计费。 ``` PUT https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3/599628f2665841b2a66fa2780fadc025/instances/change-charge-mode { "entity_ids": ["xxxxxxin14"], "charge_info": { "period_type": "month", "period_num": 1, "is_auto_renew": false, "is_auto_pay": false } } ``` #### 响应示例 实例生成包周期订单信息成功。 ``` { "order_ids": ["CSXXXXXXX"] } ``` #### 状态码 - 正常 200 - 异常 请参见[状态码](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_194.html)。 #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_195.html)。