更新时间:2024-01-31 GMT+08:00
分享

重启裸金属服务器

功能介绍

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

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

调试

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

URI

POST /v1/{project_id}/baremetalservers/action

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

参数

是否必选

描述

project_id

项目ID。

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

请求参数

重启裸金属服务器请求参数中,必须以“reboot”字段下发重启裸金属服务器请求,详见请求示例。

参数

是否必选

参数类型

描述

reboot

Object

标记为重启裸金属服务器操作,详情请参见表2

表2 reboot字段数据结构说明

参数

是否必选

参数类型

描述

type

String

重启类型:

  • SOFT:普通重启(不生效)。
  • HARD:强制重启(默认)。

servers

Array of objects

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

表3 servers字段数据结构说明

参数

是否必选

参数类型

描述

id

String

裸金属服务器ID。

可以从裸金属服务器控制台查询,或者通过调用查询裸金属服务器列表(OpenStack原生)获取。

请求示例

强制重启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
{
    "reboot": {
        "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

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

其他返回值请参考状态码

错误码

请参考错误码

分享:

    相关文档

    相关产品