接口功能介绍
该接口提供用户开启多台云主机功能。
接口约束
- 云主机需要处于关机（stopped）或节省关机（shelve）状态
2. 当前页面接口为旧版 API，未来根据实际使用情况可能退役，推荐使用新版本接口，新版本接口更加规范，覆盖场景更全。
URI
POST /v4/ecs/batch-start
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 资源池ID | 81f7728662dd11ec810800155d307d5b | |
| azName | 否 | String | 可用区名称。您可以调用资源池可用区查询，查询结果中zoneList内返回存在可用区名称(即多可用区，本字段填写实际可用区名称)，若查询结果中zoneList为空(即为单可用区，本字段填写default)。 | az1 | |
| instanceIDList | 是 | String | 云主机ID列表，多台则使用英文逗号分割 | adc614e0-e838-d73f-0618-a6d51d09070a,5ae83d07-0389-22fd-def8-995090ee3d5a |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码('800为成功，900为失败)，默认值:800 | 800 | |
| errorCode | String | 业务细分码，为product.module.code三段式码 | ||
| message | String | 失败时的错误描述，一般为英文描述 | ||
| description | String | 失败时的错误描述，一般为中文描述 | ||
| returnObj | String | 返回参数，参考returnObj对象结构 | returnObj |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| jobIDList | Array of Strings | 开机任务ID列表 |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码(800为成功，900为失败) | 800 | |
| errorCode | String | 业务细分码，为product.module.code三段式码，详见错误码说明 | Openapi.PatternCheck.NotValid | |
| message | String | 失败时的错误描述，一般为英文描述 | SUCCESS | |
| description | String | 失败时的错误描述，一般为中文描述 | 成功 | |
| returnObj | Object | 成功时返回的数据 | returnObj |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
{
"regionID": "81f7728662dd11ec810800155d307d5b",
"azName": "az1",
"instanceIDList": "adc614e0-e838-d73f-0618-a6d51d09070a,
5ae83d07-0389-22fd-def8-995090ee3d5a"
}
响应示例
{
"returnObj": {
"jobIDList": [
"a8e88ab8-888e-8888-8b88-c8f88a88e8bf",
"8a8a8c88-88aa-8888-ba8a-888b888cdfc8"
]
},
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
状态码
请参考 状态码
错误码
请参考 错误码
