续费云硬盘询价

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

1. 接口描述

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

本接口(InquiryPriceRenewDisks)用于续费云硬盘询价。

  • 只支持查询预付费模式的弹性云盘续费价格。
  • 支持与挂载实例一起续费的场景,需要在DiskChargePrepaid参数中指定CurInstanceDeadline,此时会按对齐到实例续费后的到期时间来续费询价。
  • 支持为多块云盘指定不同的续费时长,此时返回的价格为多块云盘续费的总价格。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:InquiryPriceRenewDisks
Version String 公共参数,本接口取值:2017-03-12
Region String 公共参数,详见产品支持的地域列表
DiskIds.N Array of String 云硬盘ID, 通过DescribeDisks接口查询。
DiskChargePrepaids.N Array of DiskChargePrepaid 预付费模式,即包年包月相关参数设置。通过该参数可以指定包年包月云盘的购买时长。如果在该参数中指定CurInstanceDeadline,则会按对齐到子机到期时间来续费。如果是批量续费询价,该参数与Disks参数一一对应,元素数量需保持一致。
NewDeadline String 指定云盘新的到期时间,形式如:2017-12-17 00:00:00。参数NewDeadlineDiskChargePrepaids是两种指定询价时长的方式,两者必传一个。
ProjectId Integer 云盘所属项目ID。 如传入则仅用于鉴权。

3. 输出参数

参数名称 类型 描述
DiskPrice Price 描述了续费云盘的价格。
RequestId String 唯一请求ID,每次请求都会返回。定位问题时需要提供该次请求的RequestId。

4. 错误码

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

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

5. 示例

示例1 查询云盘续费1个月的价格

输入示例

https://cbs.tencentcloudapi.com/?Action=InquiryPriceRenewDisks
&DiskIds.0=disk-jwk0zvrg
&DiskChargePrepaids.0.Period=1
&<公共请求参数>

输出示例

{
  "Response": {
    "DiskPrice": {
      "DiscountPrice": 33.26,
      "OriginalPrice": 37.8
    },
    "RequestId": "7269a7c9-daa0-48aa-372a-5a1f8029a4f4"
  }
}

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

输入示例

https://cbs.tencentcloudapi.com/?Action=InquiryPriceRenewDisks
&DiskIds.0=disk-jwk0zvrg
&DiskChargePrepaids.0.Period=1
&DiskChargePrepaids.0.CurInstanceDeadline=2018-03-17 15:15:03
&<公共请求参数>

输出示例

{
  "Response": {
    "DiskPrice": {
      "DiscountPrice": 6.0,
      "OriginalPrice": 6.0
    },
    "RequestId": "f31302ca-7e60-412c-9d84-0675e09db295"
  }
}

6. 其他资源

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