功能介绍

根据给定的云服务器ID列表，批量关闭云服务器，1分钟内最多可以处理1000台。

本接口为异步接口，当前批量关闭云服务器请求下发成功后会返回job_id，此时批量关闭云服务器并没有立即完成，需要通过调用查询任务的执行状态查询job状态，当Job状态为 SUCCESS 时代表云服务器批量关闭成功。

调试

您可以在API Explorer中调试该接口。

URI

POST /v1/{project_id}/cloudservers/action

参数说明请参见表1。

表1 参数说明

参数	是否必选	描述
project_id	是	项目ID。 获取方法请参见获取项目ID。

请求消息

表2 请求参数

参数	是否必选	参数类型	描述
os-stop	是	Object	标记为关闭云服务器操作，详情请参见表3。

表3 os-stop字段数据结构说明

参数	是否必选	参数类型	描述
servers	是	Array of objects	云服务器ID列表，详情请参见表4。
type	否	String	关机类型，默认为SOFT： SOFT：普通关机（默认）。 HARD：强制关机。

表4 servers字段数据结构说明

参数	是否必选	参数类型	描述
id	是	String	云服务器ID。

响应消息

请参考响应（任务类）。

请求示例

批量关闭ID为“616fb98f-46ca-475e-917e-2563e5a8cd19”和“726fb98f-46ca-475e-917e-2563e5a8cd20”的云服务器，请求参数必须以”os-stop”字段下发。

POST https://{endpoint}/v1/{project_id}/cloudservers/action

{
    "os-stop": {
        "type":"HARD",
        "servers": [
            {
                "id": "616fb98f-46ca-475e-917e-2563e5a8cd19"
            },
            {
                "id": "726fb98f-46ca-475e-917e-2563e5a8cd20"
            }
        ]
    }
}

响应示例

{
    "job_id": "ff808082889bd9690189061140c235fe"
}

返回值

请参考通用请求返回值。

错误码

请参考错误码。

父主题： 批量操作

内容没看懂？ 不太想学习？想快速解决？ 有偿解决： 联系专家