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

1. 接口描述

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

本接口(ModifyDisksRenewFlag)用于修改云硬盘续费标识。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:ModifyDisksRenewFlag。
Version String 公共参数,本接口取值:2020-03-24。
Region String 公共参数,详见产品支持的 地域列表
DiskIds.N Array of String 云硬盘ID列表。
示例值:["lhdisk-eobj8huv"]
RenewFlag String 自动续费标识。取值范围:
  • NOTIFY_AND_AUTO_RENEW:通知过期且自动续费
  • NOTIFY_AND_MANUAL_RENEW:通知过期不自动续费
  • DISABLE_NOTIFY_AND_MANUAL_RENEW:不通知过期不自动续费

    若该参数指定为NOTIFY_AND_AUTO_RENEW,在账户余额充足的情况下,实例到期后将按月自动续费。
    示例值:NOTIFY_AND_AUTO_RENEW
  • 3. 输出参数

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

    4. 示例

    示例1 修改磁盘续费标识

    输入示例

    POST / HTTP/1.1
    Host: lighthouse.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: ModifyDisksRenewFlag
    <公共请求参数>
    
    {
        "DiskIds": [
            "lhdisk-qx45d7ik"
        ],
        "RenewFlag": "NOTIFY_AND_AUTO_RENEW"
    }

    输出示例

    {
        "Response": {
            "RequestId": "0d5e192e-10a2-44a6-a6ce-2ac6b01f7646"
        }
    }

    5. 开发者资源

    腾讯云 API 平台

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

    API Inspector

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

    SDK

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

    命令行工具

    6. 错误码

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

    错误码 描述
    InvalidParameter 参数错误。
    InvalidParameterValue.InvalidDiskIdMalformed 参数值非法,磁盘 ID 格式非法。
    OperationDenied.DiskCreating 磁盘处于创建过程中。
    OperationDenied.DiskOperationInProgress 磁盘正在操作过程中,请稍后重试。
    OperationDenied.DiskUsageNotSupportOperation 磁盘的云盘类型不支持该操作。
    ResourceNotFound.DiskIdNotFound 磁盘 ID 不存在。
    ResourceNotFound.DiskNotFound 磁盘不存在。