续费云硬盘

最近更新时间:2024-03-12 01:38:04

我的收藏

1. 接口描述

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

本接口(RenewDisks)用于续费一个或多个轻量应用服务器云硬盘。

只有状态为 ATTACHED,UNATTACHED 或 SHUTDOWN 的数据盘才可以进行此操作。
支持批量操作。每次请求批量云硬盘的上限为 50。
本接口为异步接口,请求发送成功后会返回一个 RequestId,此时操作并未立即完成。云硬盘操作结果可以通过调用 DescribeDisks 接口查询,如果云硬盘的最新操作状态(LatestOperationState)为“SUCCESS”,则代表操作成功。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:RenewDisks。
Version String 公共参数,本接口取值:2020-03-24。
Region String 公共参数,详见产品支持的 地域列表
DiskIds.N Array of String 云硬盘ID列表。一个或多个待操作的云硬盘ID。可通过DescribeDisks接口返回值中的DiskId获取。每次请求续费数据盘数量总计上限为50。
示例值:[“lhdisk-xxxxxx”]
RenewDiskChargePrepaid RenewDiskChargePrepaid 续费云硬盘包年包月相关参数设置。
AutoVoucher Boolean 是否自动使用代金券。默认不使用。
示例值:true

3. 输出参数

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

4. 示例

示例1 续费云硬盘

续费云硬盘

输入示例

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

{
    "DiskIds": [
        "lhdisk-ovav4qmi"
    ],
    "RenewDiskChargePrepaid": {
        "CurInstanceDeadline": "2023-09-09 23:59:59"
    },
    "AutoVoucher": true
}

输出示例

{
    "Response": {
        "RequestId": "c139e106-cdb2-4923-8f1e-ea1dc4fe3a47"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation.InsufficientBalance 账户余额不足, 请及时充值。
FailedOperation.RenewResourcesFailed 续费资源失败。
InvalidParameterValue.Duplicated 参数值非法,不允许包含重复的值。
InvalidParameterValue.InvalidCurInstanceDeadline 当前实例到期时间不能早于云硬盘到期时间。
InvalidParameterValue.InvalidDiskIdMalformed 参数值非法,磁盘 ID 格式非法。
MissingParameter.MissingParameterPeriodCurInstanceDeadline 必须传入参数Period或CurInstanceDeadline。
OperationDenied.DiskCreating 磁盘处于创建过程中。
ResourceNotFound.DiskIdNotFound 磁盘 ID 不存在。
UnsupportedOperation.DiskLatestOperationUnfinished 不支持的操作,磁盘最近一次的操作尚未完成。
UnsupportedOperation.InvalidDiskState 磁盘状态不支持该操作。