接口功能介绍
支持全部开机、关机、重启资源池云主机，返回执行开机/关机/重启操作的云主机ID及其对应任务ID
准备工作：
构造请求：在调用前需要了解如何构造请求，详情查看构造请求
认证鉴权：openapi请求需要进行加密调用，详细查看认证鉴权
接口约束
1.全部开机操作仅对资源池中处于关机状态的云主机有效，全部关机、全部重启操作仅对资源池中处于开机状态的云主机有效
URI
POST /v4/ecs/operate-all-instances
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 资源池ID，您可以查看地域和可用区来了解资源池 获取： 查 资源池列表查询 |
bb9fdb42056f11eda1610242ac110002 | |
| operateType | 是 | String | 操作类型，可选值：start（全部开机）、stop（全部关机）、reboot（全部重启） | start |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| 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
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| jobIDList | Array of Objects | 任务列表 | jobIDList |
表 jobIDList
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| jobID | String | 任务ID，您可以调用查询多个异步任务的结果来查询操作是否成功 | a8e88ab8-888e-8888-8b88-c8f88a88e8bf | |
| instanceID | String | 对应任务云主机ID | adc614e0-e838-d73f-0618-a6d51d09070a |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
{
"regionID": "81f7728662dd11ec810800155d307d5b",
"operateType":"start"
}
响应示例
{
"returnObj": {
"jobIDList": [
{
"instanceID": "2c708117-023e-7f50-3e27-569f88cb18c7",
"jobID": "bebc8957-70f5-4d32-8c21-93f96f91172a"
},
{
"instanceID": "71c0e3c1-d603-7a03-3f59-7114f7e99068",
"jobID": "e2cf81ff-62be-476d-b29f-1f5c7c8d5364"
},
{
"instanceID": "14428036-5c9a-7df8-b99a-1a7f6cfd9c1c",
"jobID": "470c649b-10a5-4619-8a3c-7dc99a4197ab"
}
]
},
"details": "",
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
状态码
请参考 状态码
错误码
请参考 错误码
