操作指南

最佳实践

故障处理

API 文档

重装实例

最近更新时间:2021-07-13 08:06:45

我的收藏

1. 接口描述

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

本接口 (ResetInstance) 用于重装指定实例上的操作系统。

  • 如果指定了ImageId参数,则使用指定的镜像重装;否则按照当前实例使用的镜像进行重装。
  • 系统盘将会被格式化,并重置;请确保系统盘中无重要文件。
  • LinuxWindows系统互相切换时,该实例系统盘ID将发生变化,系统盘关联快照将无法回滚、恢复数据。
  • 密码不指定将会通过站内信下发随机密码。
  • 目前只支持系统盘类型CLOUD_BASICCLOUD_PREMIUMCLOUD_SSD类型的实例使用该接口实现LinuxWindows操作系统切换。
  • 目前不支持境外地域的实例使用该接口实现LinuxWindows操作系统切换。
  • 实例操作结果可以通过调用 DescribeInstances 接口查询,如果实例的最新操作状态(LatestOperationState)为“SUCCESS”,则代表操作成功。

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

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:ResetInstance。
Version String 公共参数,本接口取值:2017-03-12。
Region String 公共参数,详见产品支持的 地域列表
InstanceId String 实例ID。可通过 DescribeInstances API返回值中的InstanceId获取。
ImageId String 指定有效的镜像ID,格式形如img-xxx。镜像类型分为四种:
  • 公共镜像
  • 自定义镜像
  • 共享镜像
  • 服务市场镜像

  • 可通过以下方式获取可用的镜像ID:
  • 公共镜像自定义镜像共享镜像的镜像ID可通过登录控制台查询;服务镜像市场的镜像ID可通过云市场查询。
  • 通过调用接口 DescribeImages ,取返回信息中的ImageId字段。


  • 默认取值:默认使用当前镜像。
    SystemDisk SystemDisk 实例系统盘配置信息。系统盘为云盘的实例可以通过该参数指定重装后的系统盘大小来实现对系统盘的扩容操作,若不指定大小且原系统盘大小小于镜像大小,则会自动扩容,产生多余的磁盘费用。系统盘大小只支持扩容不支持缩容;重装只支持修改系统盘的大小,不能修改系统盘的类型。
    LoginSettings LoginSettings 实例登录设置。通过该参数可以设置实例的登录方式密码、密钥或保持镜像的原始登录设置。默认情况下会随机生成密码,并以站内信方式知会到用户。
    EnhancedService EnhancedService 增强服务。通过该参数可以指定是否开启云安全、云监控等服务。若不指定该参数,则默认开启云监控、云安全服务。
    HostName String 重装系统时,可以指定修改实例的主机名。
  • 点号(.)和短横线(-)不能作为 HostName 的首尾字符,不能连续使用。
  • Windows 实例:名字符长度为[2, 15],允许字母(不限制大小写)、数字和短横线(-)组成,不支持点号(.),不能全是数字。
  • 其他类型(Linux 等)实例:字符长度为[2, 60],允许支持多个点号,点之间为一段,每段允许字母(不限制大小写)、数字和短横线(-)组成。
  • 3. 输出参数

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

    4. 示例

    示例1 重装实例

    本示例用于指定镜像、登录密码和增强服务来重装实例,同时扩容实例系统盘。

    输入示例

    GET https://cvm.tencentcloudapi.com/?Action=ResetInstance
    &InstanceId=ins-r8hr2upy
    &ImageId=img-pmqg1cw7
    &SystemDisk.DiskSize=60
    &LoginSettings.Password=Qcloud@TestApi123++
    &EnhancedService.SecurityService.Enabled=TRUE
    &EnhancedService.MonitorService.Enabled=TRUE
    &<公共请求参数>

    输出示例

    {
      "Response": {
        "RequestId": "a0a66377-b79f-4a21-846c-d997d6022968"
      }
    }

    5. 开发者资源

    腾讯云 API 平台

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

    API Inspector

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

    SDK

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

    命令行工具

    6. 错误码

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

    错误码 描述
    InternalError.TradeUnknownError 内部错误
    InternalServerError 操作内部错误。
    InvalidAccount.InsufficientBalance 账户余额不足。
    InvalidAccount.UnpaidOrder 账户有未支付订单。
    InvalidImageId.Malformed 错误的镜像Id格式。
    InvalidImageId.NotFound 未找到该镜像。
    InvalidInstance.NotSupported 不被支持的实例。
    InvalidInstanceId.Malformed 无效实例ID。指定的实例ID格式错误。例如实例ID长度错误ins-1122
    InvalidInstanceId.NotFound 没有找到相应实例。
    InvalidParameter.HostNameIllegal 指定的hostName不符合规范。
    InvalidParameter.InstanceImageNotSupport 当前接口不支持实例镜像。
    InvalidParameterValue 参数取值错误。
    InvalidParameterValue.IllegalHostName HostName参数值不合法
    InvalidParameterValue.InvalidImageForGivenInstanceType 镜像ID不支持指定的实例机型。
    InvalidParameterValue.InvalidImageState 镜像状态不合规范
    InvalidParameterValue.KeyPairNotFound 请确认密钥是否存在。
    InvalidParameterValue.LimitExceeded 参数值数量超过限制。
    InvalidPassword 无效密码。指定的密码不符合密码复杂度限制。例如密码长度不符合限制等。
    MissingParameter 缺少参数错误。
    MissingParameter.MonitorService 该实例类型必须开启云监控服务
    MutexOperation.TaskRunning 同样的任务正在运行。
    OperationDenied.InstanceOperationInProgress 实例正在执行其他操作,请稍后再试。
    ResourceInUse 资源被占用。
    UnauthorizedOperation.MFAExpired 您无法进行当前操作,请确认多因子认证(MFA)是否失效。
    UnauthorizedOperation.MFANotFound 没有权限进行此操作,请确认是否存在多因子认证(MFA)。
    UnsupportedOperation.InstanceChargeType 请求不支持该实例计费模式
    UnsupportedOperation.InstanceStateCorrupted 请求不支持永久故障的实例。
    UnsupportedOperation.InstanceStateEnterRescueMode 请求不支持进入救援模式的实例
    UnsupportedOperation.InstanceStateEnterServiceLiveMigrate 不支持状态为 ENTER_SERVICE_LIVE_MIGRATE.的实例 ins-xxxxxx
    UnsupportedOperation.InstanceStateExitRescueMode 请求不支持正在退出救援模式的实例
    UnsupportedOperation.InstanceStateIsolating 请求不支持正在隔离状态的实例。
    UnsupportedOperation.InstanceStatePending 请求不支持创建未完成的实例
    UnsupportedOperation.InstanceStateRebooting 请求不支持正在重启的实例
    UnsupportedOperation.InstanceStateRescueMode 请求不支持救援模式的实例
    UnsupportedOperation.InstanceStateServiceLiveMigrate 不支持正在服务迁移的实例,请稍后再试
    UnsupportedOperation.InstanceStateShutdown 请求不支持隔离状态的实例
    UnsupportedOperation.InstanceStateStopping 请求不支持正在关机的实例
    UnsupportedOperation.InstanceStateTerminated 不支持已销毁的实例
    UnsupportedOperation.InstanceStateTerminating 请求不支持正在销毁的实例
    UnsupportedOperation.KeyPairUnsupportedWindows 密钥不支持Windows操作系统
    UnsupportedOperation.RawLocalDiskInsReinstalltoQcow2 当前镜像不支持对该实例的重装操作。
    UnsupportedOperation.StoppedModeStopCharging 不支持关机不收费特性
    目录