接口功能介绍
该接口提供用户重装多台云主机功能，通过填写相应云主机ID、镜像ID和密码对云主机进行重装。
接口约束
- 云主机需要处于关机状态。
- 若云主机存在快照，不允许执行重装操作。
- 云主机已挂载的云硬盘状态不能处于“镜像制作中”
- 当前页面接口为旧版 API，未来根据实际使用情况可能退役，推荐使用新版本接口，新版本接口更加规范，覆盖场景更全。
URI
POST /v4/ecs/batch-rebuild
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 资源池ID，您可以调用regionID查看最新的天翼云资源池列表 | 81f7728662dd11ec810800155d307d5b | |
| azName | 否 | String | 可用区名称，您可以调用获取资源池信息，查询结果中zoneList内返回存在可用区名称(即多可用区，本字段填写实际可用区名称)，若查询结果中zoneList为空(即为单可用区，本字段填写default)。 | az1 | |
| rebuildInfo | 是 | Array of Objects | 重装信息 | rebuildInfo |
表 rebuildInfo
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| ID | 是 | String | 云主机ID | adc614e0-e838-d73f-0618-a6d51d09070a | |
| imageID | 是 | String | 镜像ID，您可以调用imageID查看最新的天翼云具体资源池的镜像列表 | b1d896e1-c977-4fd4-b6c2-5432549977be | |
| password | 是 | String | 用户密码，满足以下规则： 长度在8～30个字符； 必须包含大写字母、小写字母、数字以及特殊符号中的三项； 特殊符号可选：()`~!@#$%^&*_-+=｜{}[]:;'<>,.?/\且不能以斜线号 / 开头； 不能包含3个及以上连续字符； Linux镜像不能包含镜像用户名（root）、用户名的倒序（toor）、用户名大小写变化（如RoOt、rOot等）； Windows镜像不能包含镜像用户名（Administrator）、用户名大小写变化（adminiSTrator等） |
1qaz@WSX | |
| userData | 否 | String | 用户自定义数据，需要以Base64方式编码，需要以Base64方式编码，Base64编码后的长度限制为1-16384字符 | UmVidWlsZFRlc3QyMDIyMTEyNDEzMTE= |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码(800为成功，900为失败) | 800 | |
| errorCode | String | 业务细分码，为product.module.code三段式码，详见错误码说明 | Openapi.PatternCheck.NotValid | |
| message | String | 失败时的错误描述，一般为英文描述 | SUCCESS | |
| description | String | 失败时的错误描述，一般为中文描述 | 成功 | |
| returnObj | Object | 成功时返回的数据 | returnObj |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| jobIDList | Array of Strings | 重装任务ID列表 | ["a8e88ab8-888e-8888-8b88-c8f88a88e8bf","8a8a8c88-88aa-8888-ba8a-888b888cdfc8"] |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
{
"regionID": "81f7728662dd11ec810800155d307d5b",
"azName": "az1",
"rebuildInfo": [{
"ID": "adc614e0-e838-d73f-0618-a6d51d09070a",
"imageID": "b1d896e1-c977-4fd4-b6c2-5432549977be",
"password": "rebuildTest123",
"userData": "UmVidWlsZFRlc3QyMDIyMTEyNDEzMTE="
},{
"ID": "5ae83d07-0389-22fd-def8-995090ee3d5a",
"imageID": "8f2c4f7b-49fe-45e0-8e00-8e4d68228fea",
"password": "AbCd1234",
"userData": "UmVidWlsZDJUZXN0MjAyMjExMjQxMzEx"
}]
}
响应示例
{
"returnObj": {
"jobIDList": ["a8e88ab8-888e-8888-8b88-c8f88a88e8bf","8a8a8c88-88aa-8888-ba8a-888b888cdfc8"]
},
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
状态码
请参考 状态码
错误码
请参考 错误码
