续费云硬盘

最近更新时间:2018-07-27 21:02:12

1. 接口描述

接口请求域名: cbs.tencentcloudapi.com

本接口(RenewDisk)用于续费云硬盘。

  • 只支持预付费的云硬盘。云硬盘类型可以通过DescribeDisks接口查询,见输出参数中DiskChargeType字段解释。
  • 支持与挂载实例一起续费的场景,需要在DiskChargePrepaid参数中指定CurInstanceDeadline,此时会按对齐到子机续费后的到期时间来续费。
  • 续费时请确保账户余额充足。可通过DescribeAccountBalance接口查询账户余额。

接口请求频率限制:20次/每秒

注意:本接口支持金融区地域。公共参数 Region 为金融区地域时,需要同时指定带金融区地域的域名,例如:cbs.ap-shanghai-fsi.tencentcloudapi.com

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:RenewDisk
Version String 公共参数,本接口取值:2017-03-12
Region String 公共参数,详见产品支持的地域列表
DiskChargePrepaid DiskChargePrepaid 预付费模式,即包年包月相关参数设置。通过该参数可以指定包年包月云盘的续费时长。
在云盘与挂载的实例一起续费的场景下,可以指定参数CurInstanceDeadline,此时云盘会按对齐到实例续费后的到期时间来续费。
DiskId String 云硬盘ID, 通过DescribeDisks接口查询。

3. 输出参数

参数名称 类型 描述
RequestId String 唯一请求ID,每次请求都会返回。定位问题时需要提供该次请求的RequestId。

4. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见公共错误码

错误码 描述
InvalidDisk.Busy 云硬盘忙,请稍后重试。
InvalidDisk.NotPortable 不支持非弹性云盘
InvalidDiskId.NotFound 输入的DiskId不存在。
InvalidParameterValue 无效参数值。参数值格式错误或者参数值不被支持等。
MissingParameter 参数缺失。请求没有带必选参数。

5. 示例

示例1 给云盘续费一个月,并设置自动续费标识

输入示例

https://cbs.tencentcloudapi.com/?Action=RenewDisk
&DiskId=disk-jwk0zvrg
&DiskChargePrepaid.Period=1
&DiskChargePrepaid.RenewFlag=NOTIFY_AND_AUTO_RENEW
&<公共请求参数>

输出示例

{
  "Response": {
    "RequestId": "6e2e5089-244a-4102-d347-5a1f8058b1db"
  }
}

示例2 续费实例时,需续费挂载的预付费云盘,使云盘与实例的到期时间对齐。

输入示例

https://cbs.tencentcloudapi.com/?Action=RenewDisk
&DiskId=disk-jwk0zvrg
&DiskChargePrepaid.Period=1
&DiskChargePrepaid.CurInstanceDeadline=2018-03-30 20:15:03
&DiskChargePrepaid.RenewFlag=NOTIFY_AND_AUTO_RENEW
&<公共请求参数>

输出示例

{
  "Response": {
    "DiskPrice": {
      "DiscountPrice": 9.0,
      "OriginalPrice": 9.0
    },
    "RequestId": "55db49cf-b9d7-da27-825b-5a02ba6884ca"
  }
}

6. 其他资源

云 API 3.0 提供了配套的开发工具,能更方便的调用 API 。