重装实例

最近更新时间：2023-08-09 11:38:10

前往 GitHub 编辑 我的收藏

本页目录：

说明：

当前页面接口为旧版 API，未来可能停止维护，目前不展示在左侧导航。云服务器 API 3.0 版本接口定义更加规范，访问时延下降显著，建议使用云服务器 API 3.0。

1. 接口描述

本接口 (ResetInstance) 用于重装指定实例上的操作系统。
接口请求域名：cvm.api.qcloud.com

如果指定了ImageId参数，则使用指定的镜像重装；否则按照当前实例使用的镜像进行重装。
系统盘将会被格式化，并重置；请确保系统盘中无重要文件。
Linux和Windows系统互相切换时，该实例系统盘ID将发生变化，系统盘关联快照将无法回滚、恢复数据。
密码不指定将会通过站内信下发随机密码。
目前只支持系统盘类型是CLOUD_BASIC、CLOUD_PREMIUM、CLOUD_SSD类型的实例使用该接口实现Linux和Windows操作系统切换。
目前不支持境外地域的实例使用该接口实现Linux和Windows操作系统切换。

2. 输入参数

以下请求参数列表仅列出了接口请求参数，其它参数见公共请求参数页面。

参数名称	类型	是否必选	描述
Version	String	是	表示API版本号，主要用于标识请求的不同API版本。本接口第一版本可传：2017-03-12。
InstanceId	String	是	实例 ID。可通过 DescribeInstances API 返回值中的`InstanceId`获取。
ImageId	String	否	指定有效的镜像 ID，格式形如`img-xxx`。镜像类型分为四种：公共镜像自定义镜像共享镜像服务市场镜像可通过以下方式获取可用的镜像 ID： `公共镜像`、`自定义镜像`、`共享镜像`的镜像 ID 可通过登录控制台查询；`服务镜像市场`的镜像 ID 可通过云市场查询。通过调用接口 DescribeImages，取返回信息中的`ImageId`字段。
SystemDisk	SystemDisk object	否	实例系统盘配置信息。系统盘为云盘的实例可以通过该参数指定重装后的系统盘大小来实现对系统盘的扩容操作，若不指定则默认系统盘大小保持不变。系统盘大小只支持扩容不支持缩容；重装只支持修改系统盘的大小，不能修改系统盘的类型。
LoginSettings	LoginSettings object	否	实例登录设置。通过该参数可以设置实例的登录方式密码、密钥或保持镜像的原始登录设置。默认情况下会随机生成密码，并以站内信方式知会到用户。
EnhancedService	EnhancedService object	否	增强服务。通过该参数可以指定是否开启云安全、腾讯云可观测平台等服务。若不指定该参数，则默认开启腾讯云可观测平台、云安全服务。

3. 输出参数

参数名称	类型	描述
RequestId	String	唯一请求`ID`。每次请求都会返回`RequestId`。当用户调用接口失败找后台研发人员处理时需提供该`RequestId`。

4. 错误码

以下错误码表仅列出了该接口的业务逻辑错误码，更多错误码详见公共错误码。

错误码	描述
MissingParameter	参数缺失。请求没有带必选参数。
InvalidInstanceId.NotFound	无效实例`ID`。指定的实例`ID`不存在。
InvalidInstanceId.Malformed	无效实例`ID`。指定的实例`ID`格式错误。例如实例`ID`长度错误`ins-1122`。
InvalidParameterValue	无效参数值。参数值格式错误或者参数值不被支持等。
InvalidInstance.NotSupported	实例不支持该操作。
InternalServerError	操作内部错误。

5. 示例

https://cvm.api.qcloud.com/v2/index.php?Action=ResetInstance
&Version=2017-03-12
&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"
    }
}