功能介绍
根据给定的 裸金属服务器 ID列表,批量关闭裸金属服务器。一次最多可以关闭1000台。
关闭裸金属服务器属于异步API,接口调用成功只表示请求下发成功,任务执行结果请通过查询Job状态API获取。
调试
您可以在API Explorer中调试该接口。
请求参数
关闭裸金属服务器请求参数,必须如请求示例中,以“os-stop”字段下发关闭裸金属服务器请求。
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
servers |
是 |
Array of objects |
|
type |
否 |
String |
关机类型:
|
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
id |
是 |
String |
裸金属服务器ID。 可以从裸金属服务器控制台查询,或者通过调用查询裸金属服务器列表(OpenStack原生)API获取。 |
请求示例
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" } ] } } |
响应参数
- 正常响应要素
名称 |
参数类型 |
说明 |
---|---|---|
job_id |
String |
提交任务成功后返回的任务ID,用户可以使用该ID对任务执行情况进行查询。 如何根据job_id来查询Job的执行状态,请参考查询Job状态。 |
- 异常响应要素
响应示例
- 正常响应
{ "job_id": "70a599e0-31e7-49b7-b260-868f441e862b" }
错误码
请参考错误码。