# 关闭裸金属服务器 - BatchStopBaremetalServers #### 功能介绍 根据给定的裸金属服务器ID列表，批量关闭裸金属服务器。一次最多可以关闭1000台。 ![](https://support.huaweicloud.com/api-bms/public_sys-resources/note_3.0-zh-cn.png) 关闭裸金属服务器属于异步API，接口调用成功只表示请求下发成功，任务执行结果请通过[查询Job状态 - ShowJobInfos](https://support.huaweicloud.com/api-bms/bms_api_0640.html)API获取。 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/BMS/doc?api=BatchStopBaremetalServers)中调试该接口。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-bms/bms_api_0900.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | bms:servers:stop | write | instance\* | - g:EnterpriseProjectId - g:ResourceTag/\ | - | - | #### URI POST /v1/{project_id}/baremetalservers/action 参数说明请参见[表1]。 表1参数说明 | 参数 | 是否必选 | 描述 | |:---|:---|:---| | project_id | 是 | 项目ID。 获取方式请参见[获取项目ID](https://support.huaweicloud.com/api-bms/bms_api_appendix_03.html)。 | #### 请求参数 ![](https://support.huaweicloud.com/api-bms/public_sys-resources/note_3.0-zh-cn.png) 关闭裸金属服务器请求参数，必须如请求示例中，以"os-stop"字段下发关闭裸金属服务器请求。 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | os-stop | 是 | Object | 标记为关闭裸金属服务器操作，详情请参见[表2]。 | 表2os-stop字段数据结构说明 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | servers | 是 | Array of objects | 裸金属服务器ID列表，详情请参见[表3]。 | | type | 否 | String | 关机类型，默认为HARD。 取值范围： HARD：强制关机。 | 表3servers字段数据结构说明 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | id | 是 | String | 裸金属服务器ID。 可以从裸金属服务器控制台查询，或者通过调用[查询裸金属服务器列表（废弃）](https://support.huaweicloud.com/api-bms/bms_api_0709.html)获取。 | #### 请求示例 强制关闭ID为616fb98f-46ca-475e-917e-2563e5a8cd19和726fb98f-46ca-475e-917e-2563e5a8cd20的裸金属服务器。 ``` POST https://{BMS Endpoint}/v1/bbf1946d374b44a0a2a95533562ba954/baremetalservers/action ``` ``` { "os-stop": { "type": "HARD", "servers": [ { "id": "616fb98f-46ca-475e-917e-2563e5a8cd19" }, { "id": "726fb98f-46ca-475e-917e-2563e5a8cd20" } ] } } ``` #### 响应参数 - 正常响应要素 表4正常响应要素说明 | 名称 | 参数类型 | 说明 | |:---|:---|:---| | job_id | String | 提交任务成功后返回的任务ID，用户可以使用该ID对任务执行情况进行查询。 如何根据job_id来查询Job的执行状态，请参考[查询Job状态 - ShowJobInfos](https://support.huaweicloud.com/api-bms/bms_api_0640.html)。 | - 异常响应要素 表5异常响应要素说明 | 名称 | 参数类型 | 说明 | |:---|:---|:---| | error | 字典数据结构 | 提交任务异常时返回的异常信息，详情请参见[表6]。 | 表6error数据结构 | 名称 | 参数类型 | 说明 | |:---|:---|:---| | message | String | 任务异常错误信息描述。 | | code | String | 任务异常错误信息编码。 | #### 响应示例 - 正常响应 ``` { "job_id": "70a599e0-31e7-49b7-b260-868f441e862b" } ``` #### 返回值 正常返回值： | 返回值 | 说明 | |:---|:---| | 200 | 服务器已成功处理了请求。 | 其他返回值请参考[状态码](https://support.huaweicloud.com/api-bms/bms_api_0801.html)。 #### 错误码 请参考[错误码](https://support.huaweicloud.com/api-bms/bms_api_0802.html)。