变更实例套餐

最近更新时间:2024-06-25 01:17:51

我的收藏

1. 接口描述

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

本接口(ModifyInstancesBundle)用于变更一个或多个轻量应用服务器实例套餐。

  • 只有状态为 RUNNING,STOPPED的实例才可以进行此操作。
  • 支持批量操作。每次请求批量实例的上限为 30。
  • 本接口为异步接口,请求发送成功后会返回一个 RequestId,此时操作并未立即完成。实例操作结果可以通过调用 DescribeInstances 接口查询,如果实例的最新操作状态(LatestOperationState)为“SUCCESS”,则代表操作成功。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:ModifyInstancesBundle。
Version String 公共参数,本接口取值:2020-03-24。
Region String 公共参数,详见产品支持的 地域列表
InstanceIds.N Array of String 实例ID列表。一个或多个待操作的实例ID。可通过DescribeInstances接口返回值中的InstanceId获取。每次请求批量实例的上限为15。
示例值:[“lhins-123456”]
BundleId String 待变更的套餐Id。可通过DescribeBundles接口返回值中的BundleId获取。
示例值:“bundle_ent_01”
AutoVoucher Boolean 是否自动抵扣代金券。取值范围:
true:表示自动抵扣代金券
false:表示不自动抵扣代金券
默认取值:false。
示例值:false

3. 输出参数

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

4. 示例

示例1 变更实例套餐

变更实例套餐

输入示例

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

{
    "InstanceIds": [
        "lhins-1a2b3c"
    ],
    "BundleId": "bundle_gen_lin_01",
    "AutoVoucher": true
}

输出示例

{
    "Response": {
        "RequestId": "3964a892-5399-4eb7-a35b-8bddfe683ab4"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
AuthFailure CAM签名/鉴权错误。
FailedOperation 操作失败。
FailedOperation.InstanceOperationFailed 对实例的操作失败。
FailedOperation.InsufficientBalance 账户余额不足, 请及时充值。
FailedOperation.ModifyInstancesBundleFailed 变更实例套餐失败。
InternalError 内部错误。
InvalidParameter.BundleIdNotFound 产品未定义的套餐 ID。
InvalidParameterValue.Duplicated 参数值非法,不允许包含重复的值。
InvalidParameterValue.InstanceIdMalformed 参数值非法,实例 ID 格式非法。
InvalidParameterValue.LimitExceeded 参数值非法,参数值的数量超过最大限制。
InvalidParameterValue.NotSupportModifyInstanceBundleType 实例套餐的套餐类型不支持表更至新套餐。
MissingParameter 缺少参数错误。
OperationDenied.BundleNotSupportModify 该实例不支持升级套餐操作。
OperationDenied.InstanceCreating 禁止对实例进行操作,实例在创建中,不允许进行该操作。
OperationDenied.InstanceOperationInProgress 禁止对实例进行操作,实例最近一次的操作尚在进行中。
ResourceNotFound.InstanceIdNotFound 实例 ID 不存在。
ResourceNotFound.InstanceNotFound 实例不存在。
UnsupportedOperation.InvalidInstanceState 不支持的操作,实例状态不合法。