功能介绍
根据指定的云主机ID列表,批量关机云主机,1分钟内最多可以处理1000台。
本接口为异步接口,当前批量关机云主机请求下发成功后会返回job_id,此时批量关机云主机并没有立即完成,需要通过调用查询任务的执行状态查询job状态,当Job状态为 SUCCESS 时代表云主机批量关机成功。
URI
POST /v1/{project_id}/cloudservers/action
参数说明请参见表1。
表1 表1 参数说明
参数 |
是否必选 |
描述 |
project_id |
是 |
项目ID。 获取方法请参见获取项目ID。 |
请求消息
表2 表2 请求参数
参数 |
是否必选 |
参数类型 |
描述 |
os-stop |
是 |
Object |
标记为关闭云主机操作,详情请参见表3。 |
表3 表3 os-stop字段数据结构说明
参数 |
是否必选 |
参数类型 |
描述 |
servers |
是 |
Array of objects |
云主机ID列表,详情请参见表4。 |
type |
否 |
String |
关机类型,默认为SOFT: SOFT:普通关机(默认)。 HARD:强制关机。 |
表4 表4 servers字段数据结构说明
参数 |
是否必选 |
参数类型 |
描述 |
id |
是 |
String |
云主机ID。 |
相关信息
本接口复用ECS相应接口,响应参数说明、接口使用示例、返回值等信息详见ECS文档批量关闭云服务器,该文档内容同样适用于L实例云主机。
ECS接口信息中,L实例中的云主机对应于弹性云服务器。