有奖捉虫:云通信与企业服务文档专题,速来> HOT

1. 接口描述

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

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

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

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

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

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

3. 输出参数

参数名称 类型 描述
DiskPrice PrepayPrice 描述了续费云盘的价格。
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

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

输入示例

POST / HTTP/1.1
Host: cbs.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: InquiryPriceRenewDisks
<公共请求参数>

{
    "DiskChargePrepaids": [
        {
            "Period": "1"
        }
    ],
    "DiskIds": [
        "disk-jwk0zvrg"
    ]
}

输出示例

{
    "Response": {
        "RequestId": "86f40e10-8b5e-4085-8aea-6188283e38de",
        "DiskPrice": {
            "DiscountPrice": 7,
            "UnitPrice": null,
            "UnitPriceHigh": null,
            "OriginalPriceHigh": "7",
            "OriginalPrice": 7,
            "UnitPriceDiscount": null,
            "UnitPriceDiscountHigh": null,
            "DiscountPriceHigh": "7",
            "ChargeUnit": null
        }
    }
}

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

实例当前到期时间为:2018-03-17 15:15:03,需续费一个月,调用本接口续费实例挂载的预付费云盘,使云盘与实例的到期时间对齐。

输入示例

POST / HTTP/1.1
Host: cbs.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: InquiryPriceRenewDisks
<公共请求参数>

{
    "DiskChargePrepaids": [
        {
            "CurInstanceDeadline": "2018-03-17 15:15:03",
            "Period": "1"
        }
    ],
    "DiskIds": [
        "disk-jwk0zvrg"
    ]
}

输出示例

{
    "Response": {
        "RequestId": "86f40e10-8b5e-4085-8aea-6188283e38de",
        "DiskPrice": {
            "DiscountPrice": 7,
            "UnitPrice": null,
            "UnitPriceHigh": null,
            "OriginalPriceHigh": "7",
            "OriginalPrice": 7,
            "UnitPriceDiscount": null,
            "UnitPriceDiscountHigh": null,
            "DiscountPriceHigh": "7",
            "ChargeUnit": null
        }
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

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

错误码 描述
InvalidDisk.NotPortable 不支持非弹性云盘。
InvalidDisk.NotSupported 云硬盘不支持该操作。
InvalidDiskId.NotFound 输入的DiskId不存在。
InvalidParameterValue 参数取值错误。
MissingParameter 缺少参数错误。
ResourceNotFound.NotFound 资源不存在。
ResourceUnavailable.NotPortable 非弹性云硬盘不支持此操作。
ResourceUnavailable.NotSupported 资源不支持此操作。