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

1. 接口描述

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

本接口 (RenewInstances) 用于续费包年包月实例。

  • 只支持操作包年包月实例。
  • 续费时请确保账户余额充足。可通过DescribeAccountBalance接口查询账户余额。
  • 实例操作结果可以通过调用 DescribeInstances 接口查询,如果实例的最新操作状态(LatestOperationState)为“SUCCESS”,则代表操作成功。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:RenewInstances。
Version String 公共参数,本接口取值:2017-03-12。
Region String 公共参数,详见产品支持的 地域列表
InstanceIds.N Array of String 一个或多个待操作的实例ID。可通过 DescribeInstances 接口返回值中的InstanceId获取。每次请求批量实例的上限为100。
示例值:["ins-r8hr2upy"]
InstanceChargePrepaid InstanceChargePrepaid 预付费模式,即包年包月相关参数设置。通过该参数可以指定包年包月实例的续费时长、是否设置自动续费等属性。
说明


包年包月实例该参数为必传参数。

RenewPortableDataDisk Boolean 是否续费弹性数据盘。取值范围:
  • true:表示续费包年包月实例同时续费其挂载的弹性数据盘
  • false:表示续费包年包月实例同时不再续费其挂载的弹性数据盘

    默认取值:true。
    示例值:false
  • 3. 输出参数

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

    4. 示例

    示例1 续费实例

    本示例用于续费一个实例,指定续费实例Id是ins-r8hr2upy,续费一个月,到期时通知过期但不自动续费。

    输入示例

    POST / HTTP/1.1
    Host: cvm.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: RenewInstances
    <公共请求参数>
    
    {
        "InstanceChargePrepaid": {
            "RenewFlag": "NOTIFY_AND_MANUAL_RENEW",
            "Period": "1"
        },
        "InstanceIds": [
            "ins-r8hr2upy"
        ]
    }

    输出示例

    {
        "Response": {
            "RequestId": "6ef60bec-0242-43af-bb20-270359fb54a7"
        }
    }

    5. 开发者资源

    腾讯云 API 平台

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

    API Inspector

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

    SDK

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

    命令行工具

    6. 错误码

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

    错误码 描述
    FailedOperation.InvalidInstanceApplicationRole 不支持操作的applicationRole实例
    FailedOperation.InvalidInstanceApplicationRoleEmr 请求不支持EMR的实例ins-xxxxxxxx
    InternalError.TradeUnknownError 内部错误
    InternalServerError 操作内部错误。
    InvalidAccount.InsufficientBalance 账户余额不足。
    InvalidAccount.UnpaidOrder 账户有未支付订单。
    InvalidInstance.NotSupported 不被支持的实例。
    InvalidInstanceId.Malformed 无效实例ID。指定的实例ID格式错误。例如实例ID长度错误ins-1122
    InvalidInstanceId.NotFound 没有找到相应实例。
    InvalidParameterValue 参数取值错误。
    InvalidParameterValue.InstanceIdMalformed 实例ID不合要求,请提供规范的实例ID,类似ins-xxxxxxxx,字母x代表小写字符或数字。
    InvalidParameterValue.InstanceNotSupportedMixPricingModel 不支持操作不同计费方式的实例。
    InvalidParameterValue.LimitExceeded 参数值数量超过限制。
    InvalidPeriod 无效时长。目前只支持时长:[1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36],单位:月。
    MissingParameter 缺少参数错误。
    OperationDenied.InstanceOperationInProgress 实例正在执行其他操作,请稍后再试。
    UnsupportedOperation.InstanceChargeType 请求不支持该实例计费模式
    UnsupportedOperation.InstanceMixedZoneType 中心可用区和边缘可用区实例不能混用批量操作。
    UnsupportedOperation.InstanceStateBanning 该子机处于封禁状态,请联系相关人员处理。
    UnsupportedOperation.InstanceStateFreezing 操作不支持已冻结的实例。
    UnsupportedOperation.InstanceStatePending 请求不支持创建未完成的实例
    UnsupportedOperation.InstanceStateRebooting 请求不支持正在重启的实例
    UnsupportedOperation.InstanceStateStarting 实例开机中,不允许该操作。
    UnsupportedOperation.InstanceStateStopping 请求不支持正在关机的实例
    UnsupportedOperation.InstanceStateTerminating 请求不支持正在销毁的实例
    UnsupportedOperation.InvalidDiskBackupQuota 不支持带有云硬盘备份点。
    UnsupportedOperation.SpecialInstanceType 请求不支持特殊机型的实例