文档首页/ 云数据库 RDS/ API参考/ API v3（推荐）/ 实例管理/ 按需转包周期
更新时间：2025-10-13 GMT+08:00
查看PDF
分享

按需转包周期

功能介绍

RDS实例按需转包周期接口。

调试

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

接口约束

该接口仅支持RDS for PostgreSQL引擎。

URI

  • URI格式

    POST /v3/{project_id}/instances/{instance_id}/to-period

  • 参数说明
    表1 参数说明

    名称

    是否必选

    说明

    project_id

    是

    参数解释：

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

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

    约束限制：

    不涉及。

    取值范围：

    不涉及。

    默认取值：

    不涉及。

    instance_id

    是

    参数解释：

    实例ID。

    约束限制：

    不涉及。

    取值范围：

    可通过表4中“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" 
 }
  • 异常响应

    请参见异常请求结果。

状态码

错误码

请参见错误码。

父主题： 实例管理

相关文档