華為云計算 云知識 啟動裸金屬服務器BatchStartBaremetalServers
啟動裸金屬服務器BatchStartBaremetalServers

 

功能介紹

根據(jù)給定的 裸金屬服務器 ID列表,批量啟動裸金屬服務器。一次最多可以啟動1000臺。

啟動裸金屬服務器屬于異步API,接口調(diào)用成功只表示請求下發(fā)成功,任務執(zhí)行結(jié)果請通過查詢Job狀態(tài)API獲取。

調(diào)試

您可以在API Explorer中調(diào)試該接口。

URI

POST /v1/{project_id}/baremetalservers/action

參數(shù)說明請參見表1。
表1 參數(shù)說明

參數(shù)

是否必選

描述

project_id

項目ID。

獲取方式請參見獲取項目ID。

請求參數(shù)

啟動裸金屬服務器請求參數(shù)中,必須以“os-start”字段下發(fā)啟動裸金屬服務器請求,請參見下面的請求示例。

參數(shù)

是否必選

參數(shù)類型

描述

os-start

Object

標記為啟動裸金屬服務器操作,詳情請參見表2 os-start字段數(shù)據(jù)結(jié)構(gòu)說明。

表2 os-start字段數(shù)據(jù)結(jié)構(gòu)說明

參數(shù)

是否必選

參數(shù)類型

描述

servers

Array of objects

裸金屬服務器ID列表,詳情請參見表3 servers字段數(shù)據(jù)結(jié)構(gòu)說明。

表3 servers字段數(shù)據(jù)結(jié)構(gòu)說明

參數(shù)

是否必選

參數(shù)類型

描述

id

String

裸金屬服務器ID。

可以從裸金屬服務器控制臺查詢,或者通過調(diào)用查詢裸金屬服務器列表(OpenStack原生)API獲取。

請求示例

啟動ID為616fb98f-46ca-475e-917e-2563e5a8cd19和726fb98f-46ca-475e-917e-2563e5a8cd20的裸金屬服務器。
POST https://{BMS Endpoint}/v1/bbf1946d374b44a0a2a95533562ba954/baremetalservers/action
{
    "os-start": {
        "servers": [
            {
                "id": "616fb98f-46ca-475e-917e-2563e5a8cd19"
            },
            {
                "id": "726fb98f-46ca-475e-917e-2563e5a8cd20"
            }
        ]
    }
}

響應參數(shù)

  • 正常響應要素
表4 正常響應要素說明

名稱

參數(shù)類型

說明

job_id

String

提交任務成功后返回的任務ID,用戶可以使用該ID對任務執(zhí)行情況進行查詢。

如何根據(jù)job_id來查詢Job的執(zhí)行狀態(tài),請參考查詢Job狀態(tài)

  • 異常響應要素
表5 異常響應要素說明

名稱

參數(shù)類型

說明

error

字典數(shù)據(jù)結(jié)構(gòu)

提交任務異常時返回的異常信息,詳情請參見表1 error數(shù)據(jù)結(jié)構(gòu)。

表6 error數(shù)據(jù)結(jié)構(gòu)

名稱

參數(shù)類型

說明

message

String

任務異常錯誤信息描述。

code

String

任務異常錯誤信息編碼。

響應示例

  • 正常響應
    { 
        "job_id": "70a599e0-31e7-49b7-b260-868f441e862b" 
    } 
    

返回值

正常返回值:

返回值

說明

200

服務器已成功處理了請求。

其他返回值請參考狀態(tài)碼。

錯誤碼

請參考錯誤碼