文档首页/ 裸金属服务器 BMS/ API参考/ API/ 裸金属服务器状态管理/ 关闭裸金属服务器
更新时间：2024-10-22 GMT+08:00
查看PDF
分享

关闭裸金属服务器

功能介绍

根据给定的裸金属服务器ID列表，批量关闭裸金属服务器。一次最多可以关闭1000台。

关闭裸金属服务器属于异步API，接口调用成功只表示请求下发成功，任务执行结果请通过查询Job状态API获取。

URI

POST /v1/{project_id}/baremetalservers/action

参数说明请参见表1。
表1 参数说明

参数

是否必选

描述

project_id

是

项目ID。

获取方式请参见获取项目ID。

请求参数

关闭裸金属服务器请求参数，必须如请求示例中，以“os-stop”字段下发关闭裸金属服务器请求。

参数

是否必选

参数类型

描述

os-stop

是

Object

标记为关闭裸金属服务器操作，详情请参见表2。
表2 os-stop字段数据结构说明

参数

是否必选

参数类型

描述

servers

是

Array of objects

裸金属服务器ID列表，详情请参见表3。

type

否

String

关机类型：

  • SOFT：普通关机（不生效）。
  • HARD：强制关机（默认）。
表3 servers字段数据结构说明

参数

是否必选

参数类型

描述

id

是

String

裸金属服务器ID。

可以从裸金属服务器控制台查询，或者通过调用查询裸金属服务器列表（废弃）获取。

请求示例

强制关闭ID为616fb98f-46ca-475e-917e-2563e5a8cd19和726fb98f-46ca-475e-917e-2563e5a8cd20的裸金属服务器。 
1
 
POST https://{BMS Endpoint}/v1/bbf1946d374b44a0a2a95533562ba954/baremetalservers/action

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
 
{
    "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状态。
  • 异常响应要素
表5 异常响应要素说明

名称

参数类型

说明

error

字典数据结构

提交任务异常时返回的异常信息，详情请参见表6。
表6 error数据结构

名称

参数类型

说明

message

String

任务异常错误信息描述。

code

String

任务异常错误信息编码。

响应示例

  • 正常响应 
    1
2
3
    		 
    { 
    "job_id": "70a599e0-31e7-49b7-b260-868f441e862b" 
}

返回值

正常返回值：

返回值

说明

200

服务器已成功处理了请求。

其他返回值请参考状态码。

错误码

请参考错误码。