调整实例配置

最近更新时间:2018-08-17 17:02:19

1. 接口描述

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

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

  • 目前只支持系统盘类型CLOUD_BASICCLOUD_PREMIUMCLOUD_SSD类型的实例使用该接口进行机型调整。
  • 目前不支持CDH实例使用该接口调整机型。 目前不支持跨机型系统来调整机型,即使用该接口时指定的InstanceType和实例原来的机型需要属于同一系列。 对于包年包月实例,使用该接口会涉及扣费,请确保账户余额充足。可通过DescribeAccountBalance接口查询账户余额。

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

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

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. 错误码

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

    错误码 描述
    InternalServerError 操作内部错误。
    InvalidAccount.InsufficientBalance 账户余额不足。
    InvalidAccount.UnpaidOrder 账户有未支付订单。
    InvalidInstance.NotSupported 不被支持的实例。
    InvalidInstanceId.Malformed 无效实例ID。指定的实例ID格式错误。例如实例ID长度错误ins-1122
    InvalidInstanceId.NotFound 没有找到相应实例。
    InvalidParameter 无效参数。参数不合要求或者参数不被支持等。
    InvalidParameterValue 无效参数值。参数值格式错误或者参数值不被支持等。
    InvalidPermission 账户不支持该操作。
    MissingParameter 参数缺失。请求没有带必选参数。

    5. 示例

    示例1 重置实例机型

    输入示例

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

    输出示例

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

    6. 其他资源

    云 API 3.0 提供了配套的开发工具,能更方便的调用 API 。