1. 接口描述
接口请求域名： cbs.tencentcloudapi.com 。
本接口（RenewDisk）用于续费云硬盘。
- 只支持预付费的云硬盘。云硬盘类型可以通过DescribeDisks接口查询，见输出参数中DiskChargeType字段解释。
- 支持与挂载实例一起续费的场景，需要在DiskChargePrepaid参数中指定CurInstanceDeadline，此时会按对齐到子机续费后的到期时间来续费。
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：RenewDisk。 |
| Version | 是 | String | 公共参数，本接口取值：2017-03-12。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| DiskChargePrepaid | 是 | DiskChargePrepaid | 预付费模式，即包年包月相关参数设置。通过该参数可以指定包年包月云硬盘的续费时长。 在云硬盘与挂载的实例一起续费的场景下，可以指定参数CurInstanceDeadline，此时云硬盘会按对齐到实例续费后的到期时间来续费。 |
| DiskId | 是 | String | 云硬盘ID， 通过DescribeDisks接口查询。 示例值：disk-jwk0zvrg |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 给云硬盘续费一个月，并设置自动续费标识
给云硬盘续费一个月，并设置自动续费标识
输入示例
POST / HTTP/1.1
Host: cbs.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: RenewDisk
<公共请求参数>
{
"DiskChargePrepaid": {
"RenewFlag": "NOTIFY_AND_AUTO_RENEW",
"Period": "1"
},
"DiskId": "disk-jwk0zvrg"
}输出示例
{
"Response": {
"RequestId": "6e2e5089-244a-4102-d347-5a1f8058b1db"
}
}示例2 续费实例时，需续费挂载的预付费云硬盘，使云硬盘与实例的到期时间对齐。
实例当前到期时间为：2018-03-30 20:15:03，需续费一个月，调用本接口续费实例挂载的预付费云硬盘，使云硬盘与实例的到期时间对齐，并设置云硬盘为自动续费。
输入示例
POST / HTTP/1.1
Host: cbs.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: RenewDisk
<公共请求参数>
{
"DiskChargePrepaid": {
"RenewFlag": "NOTIFY_AND_AUTO_RENEW",
"CurInstanceDeadline": "2018-03-30 20:15:03",
"Period": "1"
},
"DiskId": "disk-jwk0zvrg"
}输出示例
{
"Response": {
"RequestId": "6e2e5089-244a-4102-d347-5a1f8058b1db"
}
}5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| AuthFailure | CAM签名/鉴权错误。 |
| InternalError | 内部错误。 |
| InternalError.ComponentError | 依赖组件请求失败，请联系客服人员解决。 |
| InvalidAccount.InsufficientBalance | 账户余额不足。 |
| InvalidDisk.Busy | 云硬盘忙，请稍后重试。 |
| InvalidDisk.NotPortable | 不支持非弹性云盘。 |
| InvalidDisk.NotSupported | 云硬盘不支持该操作。 |
| InvalidDiskId.NotFound | 输入的DiskId不存在。 |
| InvalidParameter | 参数错误。 |
| InvalidParameterValue | 参数取值错误。 |
| MissingParameter | 缺少参数错误。 |
| ResourceUnavailable.NotPortable | 非弹性云硬盘不支持此操作。 |
| ResourceUnavailable.NotSupported | 资源不支持此操作。 |
| TradeDealConflict | 订单冲突。 |
