操作指南

API 文档

重装系统

最近更新时间:2022-06-14 06:13:38

我的收藏

1. 接口描述

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

本接口(ResetInstance)用于重装指定实例上的镜像。

  • 如果指定了 BlueprintId 参数,则使用指定的镜像重装;否则按照当前实例使用的镜像进行重装。
  • 系统盘将会被格式化,并重置;请确保系统盘中无重要文件。
  • 目前不支持实例使用该接口实现 LINUX_UNIX 和 WINDOWS 操作系统切换。
  • 本接口为异步接口,请求发送成功后会返回一个 RequestId,此时操作并未立即完成。实例操作结果可以通过调用 DescribeInstances 接口查询,如果实例的最新操作状态(LatestOperationState)为“SUCCESS”,则代表操作成功。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:ResetInstance。
Version String 公共参数,本接口取值:2020-03-24。
Region String 公共参数,详见产品支持的 地域列表
InstanceId String 实例 ID。可通过DescribeInstances接口返回值中的InstanceId获取。
BlueprintId String 镜像 ID。可通过DescribeBlueprints接口返回值中的BlueprintId获取。

3. 输出参数

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

4. 示例

示例1 重装实例

本示例用于指定镜像来重装实例。

输入示例

https://lighthouse.tencentcloudapi.com/?Action=ResetInstance
&InstanceId=lhins-ruy9d2tw
&BlueprintId=lhbp-5e8807lo
&<公共请求参数>

输出示例

{
  "Response": {
    "RequestId": "cb7aaa99-b31a-4767-9d41-4ebdbdf3ba9c"
  }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation.InstanceOperationFailed 对实例的操作失败。
InternalError.DescribeInstanceStatus 查询实例状态失败,请稍后重试。
InternalError.InvalidCommandNotFound 命令 DescribeInstanceLoginKeyPair 无法找到。
InvalidParameterValue.BlueprintConfigNotMatch 该实例配置不符合指定镜像的要求。
InvalidParameterValue.BlueprintId 镜像 ID 不合法,重装实例不允许切换操作系统类型。
InvalidParameterValue.BlueprintIdMalformed 参数值非法,镜像 ID 格式非法。
InvalidParameterValue.Duplicated 参数值非法,不允许包含重复的值。
InvalidParameterValue.InstanceIdMalformed 参数值非法,实例 ID 格式非法。
InvalidParameterValue.LimitExceeded 参数值非法,参数值的数量超过最大限制。
InvalidParameterValue.NotAllowToChangePlatformType 不允许改变平台类型。
InvalidParameterValue.OutOfRange 参数值非法,不在合法范围内。
InvalidParameterValue.TooLong 参数取值过长,超过最大长度。
OperationDenied.InstanceCreating 禁止对实例进行操作,实例在创建中,不允许进行该操作。
OperationDenied.InstanceOperationInProgress 禁止对实例进行操作,实例最近一次的操作尚在进行中。
ResourceNotFound.BlueprintIdNotFound 镜像 ID 不存在。
ResourceNotFound.InstanceIdNotFound 实例 ID 不存在。
ResourceNotFound.InstanceNotFound 实例不存在。
ResourceUnavailable.BlueprintUnavailable 镜像资源不可用。
UnauthorizedOperation.MFANotFound MFA 不存在。
UnauthorizedOperation.NoPermission 无权限。
UnsupportedOperation.InvalidInstanceState 不支持的操作,实例状态不合法。
UnsupportedOperation.LatestOperationUnfinished 不支持的操作,实例最近一次的操作尚未完成。
UnsupportedOperation.SystemBusy 系统忙。
目录