重装一台轻量型云主机
更新时间 2025-08-04 18:52:44
最近更新时间: 2025-08-04 18:52:44
重装一台轻量型云主机
接口功能介绍
该接口提供用户重装一台轻量型云主机功能，通过填写相应云主机ID、镜像ID对轻量云主机进行重装。
准备工作：
??构造请求：在调用前需要了解如何构造请求，详情查看构造请求
??认证鉴权：openapi请求需要进行加密调用，详细查看认证鉴权
注意事项：
??异步接口：该接口为异步接口，请求过后会拿到任务ID（jobID），后续可以调用查询一个异步任务的结果来查询操作是否成功
接口约束
??1. 确保当前请求资源池下，该轻量型云主机、镜像存在（即instanceID、imageID真实存在且与regionID相对应）
??2. 轻量云主机需要处于关机状态（stopped），您可以调用查询轻量型云主机详细信息查询结果中的instanceStatus字段来确认当前轻量型云主机状态
??3. 若当前轻量型云主机存在系统盘快照，不允许执行重装操作，您可以调用查询云硬盘快照列表输入当前云主机系统盘ID，来查询是否存在系统盘快照
??4. 确保云主机上的硬盘均处于已挂载状态（in-use），您可以调用查询云硬盘详情（基于diskID）查询当前云硬盘状态
??5. 重装镜像大小不可大于当前云主机系统盘，您可以分别调用查询云硬盘详情（基于diskID）和查询镜像详细信息查询当前云硬盘大小与镜像大小
URI
POST /v4/ecs/lite/rebuild-instance
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 资源池ID，您可以查看地域和可用区来了解资源池 获取： 查 资源池列表查询 |
bb9fdb42056f11eda1610242ac110002 | |
| instanceID | 是 | String | 云主机ID，您可以查看弹性云主机了解云主机的相关信息 获取： 查 查询云主机列表 创 创建一台按量付费或包年包月的云主机 创 批量创建按量付费或包年包月云主机 |
adc614e0-e838-d73f-0618-a6d51d09070a | |
| password | 是 | String | 用户密码，满足以下规则： 长度在8-30个字符； 必须包含大写字母、小写字母、数字以及特殊符号中的三项； 特殊符号可选：()`~!@#$%^&*_-+=｜{}[]:;'<>,.?/\且不能以斜线号 / 开头； 不能包含3个及以上连续字符； Linux镜像不能包含镜像用户名（root）、用户名的倒序（toor）、用户名大小写变化（如RoOt、rOot等）； Windows镜像不能包含镜像用户名（Administrator）、用户名大小写变化（adminiSTrator等） |
rebuildTest01 | |
| imageID | 否 | String | 镜像ID，您可以查看镜像概述来了解云主机镜像 获取： 查 查询可以使用的镜像资源 创 创建私有镜像（云主机系统盘） 注：不填默认以原镜像进行重装 |
b1d896e1-c977-4fd4-b6c2-5432549977be |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码（800为成功，900为失败） | 800 | |
| errorCode | String | 错误码，为product.module.code三段式码 | Openapi.PatternCheck.NotValid | |
| error | String | 错误码，为product.module.code三段式码 | Openapi.PatternCheck.NotValid | |
| message | String | 失败时的错误描述，一般为英文描述 | SUCCESS | |
| description | String | 失败时的错误描述，一般为中文描述 | 成功 | |
| returnObj | Object | 成功时返回的数据 | returnObj |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| jobID | String | 重装任务ID，您可以调用查询一个异步任务的结果来查询操作是否成功。 注：当免费镜像重装时，返回该参数；当付费镜像重装时，不返回该参数 |
a8e88ab8-888e-8888-8b88-c8f88a88e8bf |
请求示例
请求头header
无
请求体body
示例1： 使用原镜像进行重装云主机
在华东1资源池以原镜像重装一台云主机
{
"regionID": "bb9fdb42056f11eda1610242ac110002",
"instanceID": "adc614e0-e838-d73f-0618-a6d51d09070a",
"password": "rebuildTest01"
}
示例2：使用新镜像进行重装云主机
在华东1资源池使用新镜像进行重装云主机
{
"regionID": "bb9fdb42056f11eda1610242ac110002",
"instanceID": "adc614e0-e838-d73f-0618-a6d51d09070a",
"password": "rebuildTest01",
"imageID": ""9021e932-8074-48ca-aa18-4920ae891f82
}
响应示例
{
"returnObj": {
"jobID": "a8e88ab8-888e-8888-8b88-c8f88a88e8bf"
},
"errorCode": "",
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 表示请求成功 |
错误码
| errorCode | 描述 |
|---|---|
| Openapi.PatternCheck.NotValid | 请求参数无效 |
| Ecs.RegionInfo.Empty | 查询资源池信息为空或资源池不存在，请确认资源池ID是否有效 |
| Ecs.RegionInfo.AccessFailed | 查询资源池失败，请重试。如果多次尝试失败，请提交工单 |
| Ecs.RegionInfo.DataDamaged | 查询资源池信息不符预期，请重试。如果多次尝试失败，请提交工单 |
| LiteEcs.RegionVersion.NotSupport | 当前API不支持该资源池，请切换资源池重试 |
| Openapi.EcsWorkorder.AccessFailed | 查询云主机失败，请重试。如果多次尝试失败，请提交工单 |
| Ecs.Instance.NotFound | 云主机不存在，请确认云主机ID是否有效 |
| Ecs.Instance.StatusNotValid | 云主机没有处于["stopped"]状态之一，请再次确认云主机状态 |
| Ecs.Volume.StatusNotValid | 云主机存在磁盘状态不合法，请确认磁盘状态 |
| Ecs.Instance.HasSnapshot | 云主机存在系统盘快照 |
| Ecs.Image.OverSize | 镜像大小不可超过系统盘大小 |
| Openapi.EcsCheck.UnknownError | 云主机检查失败，请重试。如果多次尝试失败，请提交工单 |
| Ecs.Instance.ActionFailed | 云主机执行动作失败，请重试。如果多次尝试失败，请提交工单 |
| Ecs.Image.NotFound | 镜像不存在或不符合要求，请确认镜像信息是否正确 |
