文档首页/云数据库 GaussDB/API参考/API（推荐）/实例管理/按需转包周期 - ChangingtheBillingModefromPay-per-UsetoYearly/Monthly
更新时间：2026-04-08 GMT+08:00
查看PDF
分享

按需转包周期 - ChangingtheBillingModefromPay-per-UsetoYearly/Monthly

功能介绍

将按需计费的实例转为包周期计费。

调试

您可以在API Explorer中调试该接口。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，需具备如下身份策略权限。

    授权项

    访问级别

    资源类型（*为必须）

    条件键

    别名

    依赖的授权项

    gaussdb:instance:changeDemandToPeriod

    ReadWrite

    instance

    -

    gaussdb:instance:changeDemandToPeriod

    -

URI

PUT /v3/{project_id}/instances/change-charge-mode

表1 参数说明

名称

是否必选

参数类型

说明

project_id

是

String

参数解释：

租户在某一Region下的项目ID。

获取方法请参见获取项目ID。

约束限制：

不涉及。

取值范围：

只能由英文字母、数字组成，且长度为32个字符。

默认取值：

不涉及。

请求参数

名称

是否必选

参数类型

说明

entity_ids

是

Array of strings

参数解释：

需要转成包周期计费模式的实例ID列表。

约束限制：

不涉及。

charge_info

是

Object

参数解释：

包周期相关信息。详见表2。

约束限制：

不涉及。

表2 charge_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

响应参数

表3 参数说明

名称

参数类型

说明

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"]
}

状态码

错误码

请参见错误码。

父主题：实例管理

相关文档