文档中心 云硬盘 API 文档 云硬盘相关接口 修改弹性云盘计费模式

修改弹性云盘计费模式

最近更新时间:2019-09-19 20:28:02

1. 接口描述

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

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

本接口 (ModifyDisksChargeType) 用于切换云盘的计费模式。

只支持从 POSTPAID_BY_HOUR 计费模式切换为PREPAID计费模式。 非弹性云盘不支持此接口,请通过修改实例计费模式接口将实例连同非弹性云盘一起转换。 默认接口请求频率限制:10次/秒。

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

注意:本接口支持金融区地域。由于金融区和非金融区是隔离不互通的,因此当公共参数 Region 为金融区地域(例如 ap-shanghai-fsi)时,需要同时指定带金融区地域的域名,最好和 Region 的地域保持一致,例如:cbs.ap-shanghai-fsi.tencentcloudapi.com。

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:ModifyDisksChargeType
Version String 公共参数,本接口取值:2017-03-12
Region String 公共参数,详见产品支持的 地域列表
DiskIds.N Array of String 一个或多个待操作的云硬盘ID。每次请求批量云盘上限为100。
DiskChargePrepaid DiskChargePrepaid 预付费模式,即包年包月相关参数设置。通过该参数可以指定包年包月实例的购买时长、是否设置自动续费等属性。

3. 输出参数

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

4. 示例

示例1 切换云盘的计费模式

本示例用于切换一个云盘的计费模式(将按量计费云盘转换为包年包月云盘,并购买一个月时长)。

输入示例

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

输出示例

{
  "Response": {
    "RequestId": "d39d6c09-44e9-4e80-8661-77b5ff3cbc15"
  }
}

5. 开发者资源

API Explorer

该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

SDK

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

命令行工具

6. 错误码

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

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