操作指南

最佳实践

故障处理

API 文档

调整实例配置

最近更新时间:2021-07-20 08:07:21

我的收藏

1. 接口描述

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

本接口 (ResetInstancesType) 用于调整实例的机型。

  • 目前只支持系统盘类型是CLOUD_BASIC、CLOUD_PREMIUM、CLOUD_SSD类型的实例使用该接口进行机型调整。
  • 目前不支持CDH实例使用该接口调整机型。对于包年包月实例,使用该接口会涉及扣费,请确保账户余额充足。可通过DescribeAccountBalance接口查询账户余额。
  • 本接口为异步接口,调整实例配置请求发送成功后会返回一个RequestId,此时操作并未立即完成。实例操作结果可以通过调用 DescribeInstances 接口查询,如果实例的最新操作状态(LatestOperationState)为“SUCCESS”,则代表调整实例配置操作成功。

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

注意:本接口支持金融区地域。由于金融区和非金融区是隔离不互通的,因此当公共参数 Region 为金融区地域(例如 ap-shanghai-fsi)时,需要同时指定带金融区地域的域名,最好和 Region 的地域保持一致,例如:cvm.ap-shanghai-fsi.tencentcloudapi.com。

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:ResetInstancesType。
Version String 公共参数,本接口取值:2017-03-12。
Region String 公共参数,详见产品支持的 地域列表
InstanceIds.N Array of String 一个或多个待操作的实例ID。可通过DescribeInstances接口返回值中的InstanceId获取。本接口目前仅支持每次操作1个实例。
InstanceType String 实例机型。不同实例机型指定了不同的资源规格,具体取值可通过调用接口DescribeInstanceTypeConfigs来获得最新的规格表或参见实例类型描述。
ForceStop Boolean 是否对运行中的实例选择强制关机。建议对运行中的实例先手动关机。取值范围:
  • TRUE:表示在正常关机失败后进行强制关机
  • FALSE:表示在正常关机失败后不进行强制关机

    默认取值:FALSE。

    强制关机的效果等同于关闭物理计算机的电源开关。强制关机可能会导致数据丢失或文件系统损坏,请仅在服务器不能正常关机时使用。
  • 3. 输出参数

    参数名称 类型 描述
    RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 重置实例机型

    当目前的机型配置不满足业务需求时,您可以重新调整其规格。

    输入示例

    GET https://cvm.tencentcloudapi.com/?Action=ResetInstancesType
    &InstanceIds.0=ins-r8hr2upy
    &InstanceType=S5.16XLARGE256
    &<公共请求参数>

    输出示例

    {
    "Response": {
      "RequestId": "d39d6c09-44e9-4e80-8661-77b5ff3cbc15"
    }
    }

    5. 开发者资源

    腾讯云 API 平台

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

    API Inspector

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

    SDK

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

    命令行工具

    6. 错误码

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

    错误码 描述
    FailedOperation.PromotionalPerioRestriction 促销期内购买的实例不允许调整配置或计费模式。
    InternalError.TradeUnknownError 内部错误
    InternalServerError 操作内部错误。
    InvalidAccount.InsufficientBalance 账户余额不足。
    InvalidAccount.UnpaidOrder 账户有未支付订单。
    InvalidHostId.Malformed 无效CDH ID。指定的CDH ID格式错误。例如ID长度错误host-1122
    InvalidInstance.NotSupported 不被支持的实例。
    InvalidInstanceId.Malformed 无效实例ID。指定的实例ID格式错误。例如实例ID长度错误ins-1122
    InvalidInstanceId.NotFound 没有找到相应实例。
    InvalidInstanceType.Malformed 指定InstanceType参数格式不合法。
    InvalidParameter 参数错误。
    InvalidParameterValue 参数取值错误。
    InvalidParameterValue.LimitExceeded 参数值数量超过限制。
    InvalidParameterValue.ZoneNotSupported 请求不支持该可用区
    InvalidPermission 账户不支持该操作。
    InvalidZone.MismatchRegion 指定的zone不存在。
    LimitExceeded.EniNumLimit 特定实例当前ENI数量已超过目标实例类型的ENI允许的最大值,需删除部分ENI后重试。
    LimitExceeded.InstanceTypeBandwidth 目标实例规格不支持当前规格的外网带宽上限,不支持调整。具体可参考公网网络带宽上限
    MissingParameter 缺少参数错误。
    OperationDenied.InstanceOperationInProgress 实例正在执行其他操作,请稍后再试。
    ResourceInsufficient.SpecifiedInstanceType 指定的实例类型库存不足。
    ResourceUnavailable.InstanceType 该可用区不售卖此机型
    ResourcesSoldOut.AvailableZone 该可用区已售罄
    ResourcesSoldOut.SpecifiedInstanceType 指定的实例类型已售罄。
    UnauthorizedOperation.MFAExpired 您无法进行当前操作,请确认多因子认证(MFA)是否失效。
    UnauthorizedOperation.MFANotFound 没有权限进行此操作,请确认是否存在多因子认证(MFA)。
    UnsupportedOperation.InstanceStateRebooting 请求不支持正在重启的实例
    UnsupportedOperation.InstanceStateRunning 请求不支持开机状态的实例
    UnsupportedOperation.InstanceStateShutdown 请求不支持隔离状态的实例
    UnsupportedOperation.InstanceStateStopping 请求不支持正在关机的实例
    UnsupportedOperation.SpecialInstanceType 请求不支持特殊机型的实例
    UnsupportedOperation.StoppedModeStopCharging 不支持关机不收费特性
    UnsupportedOperation.UnsupportedChangeInstanceFamily 指定机型不支持跨机型调整配置。
    UnsupportedOperation.UnsupportedChangeInstanceFamilyToSA3 目标机型是SA3, 不支持变配。
    目录