接口功能介绍
该接口提供用户关闭多台云主机功能，可选两种关机模式：普通关机、强制关机。
普通关机与强制关机模式下，请求下发后云主机变为关机中（stopping）状态，待异步任务完成后，云主机变为关机（stopped）状态。
准备工作：
构造请求：在调用前需要了解如何构造请求，详情查看构造请求
认证鉴权：openapi请求需要进行加密调用，详细查看认证鉴权
注意事项：
多台操作：当前接口进行批量操作，关闭一台云主机建议使用接口关闭一台云主机进行操作
异步接口：该接口为异步接口，请求过后会拿到任务ID（jobID），后续可以调用查询多个异步任务的结果来查询这些操作是否成功
接口约束
1. 确保当前请求资源池下，这些云主机存在（即instanceIDList中逗号分隔的ID真实存在且与regionID相对应）
2. 云主机需要处于开机状态（running），您可以调用查询云主机列表或获取多台云主机的状态信息查询结果中的instanceStatus字段来确认当前云主机状态
3. 批量关闭云主机的最大数量为50台
URI
POST /v4/ecs/batch-stop-instances
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 资源池ID，您可以查看地域和可用区来了解资源池 获取： 查 资源池列表查询 |
bb9fdb42056f11eda1610242ac110002 | |
| instanceIDList | 是 | String | 云主机ID列表，多台使用英文逗号分割，您可以查看弹性云主机了解云主机的相关信息 获取： 查 查询云主机列表 创 创建一台按量付费或包年包月的云主机 创 批量创建按量付费或包年包月云主机 注：批量关闭云主机的最大数量为50台 |
adc614e0-e838-d73f-0618-a6d51d09070a,5ae83d07-0389-22fd-def8-995090ee3d5a | |
| force | 否 | Boolean | 是否强制关机，取值范围：true（强制关机）、false（普通关机）。 注：默认值false。 |
false |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| 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
示例：关闭两台华东1资源池的云主机
{
"regionID":"bb9fdb42056f11eda1610242ac110002",
"instanceIDList":"adc614e0-e838-d73f-0618-a6d51d09070a,5ae83d07-0389-22fd-def8-995090ee3d5a",
"force":false
}
响应示例
{
"returnObj":{
"jobIDList":[
{
"instanceID":"adc614e0-e838-d73f-0618-a6d51d09070a",
"jobID":"a8e88ab8-888e-8888-8b88-c8f88a88e8bf"
},
{
"instanceID":"5ae83d07-0389-22fd-def8-995090ee3d5a",
"jobID":"8a8a8c88-88aa-8888-ba8a-888b888cdfc8"
}
]
},
"message":"SUCCESS",
"description":"成功",
"statusCode":800
}
状态码
请参考 状态码
错误码
请参考 错误码
