華為云計(jì)算 云知識(shí) 關(guān)閉裸金屬服務(wù)器BatchStopBaremetalServers
關(guān)閉裸金屬服務(wù)器BatchStopBaremetalServers

 

功能介紹

根據(jù)給定的 裸金屬服務(wù)器 ID列表,批量關(guān)閉裸金屬服務(wù)器。一次最多可以關(guān)閉1000臺(tái)。

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

調(diào)試

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

URI

POST /v1/{project_id}/baremetalservers/action

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

參數(shù)

是否必選

描述

project_id

項(xiàng)目ID。

獲取方式請(qǐng)參見獲取項(xiàng)目ID。

請(qǐng)求參數(shù)

關(guān)閉裸金屬服務(wù)器請(qǐng)求參數(shù),必須如請(qǐng)求示例中,以“os-stop”字段下發(fā)關(guān)閉裸金屬服務(wù)器請(qǐng)求。

參數(shù)

是否必選

參數(shù)類型

描述

os-stop

Object

標(biāo)記為關(guān)閉裸金屬服務(wù)器操作,詳情請(qǐng)參見表2 os-stop字段數(shù)據(jù)結(jié)構(gòu)說明。

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

參數(shù)

是否必選

參數(shù)類型

描述

servers

Array of objects

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

type

String

關(guān)機(jī)類型:

  • SOFT:普通關(guān)機(jī)(不生效)。
  • HARD:強(qiáng)制關(guān)機(jī)(默認(rèn))。
表3 servers字段數(shù)據(jù)結(jié)構(gòu)說明

參數(shù)

是否必選

參數(shù)類型

描述

id

String

裸金屬服務(wù)器ID。

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

請(qǐng)求示例

強(qiáng)制關(guān)閉ID為616fb98f-46ca-475e-917e-2563e5a8cd19和726fb98f-46ca-475e-917e-2563e5a8cd20的裸金屬服務(wù)器。
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"
            }
        ]
    }
}

響應(yīng)參數(shù)

  • 正常響應(yīng)要素
表4 正常響應(yīng)要素說明

名稱

參數(shù)類型

說明

job_id

String

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

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

  • 異常響應(yīng)要素
表5 異常響應(yīng)要素說明

名稱

參數(shù)類型

說明

error

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

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

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

名稱

參數(shù)類型

說明

message

String

任務(wù)異常錯(cuò)誤信息描述。

code

String

任務(wù)異常錯(cuò)誤信息編碼。

響應(yīng)示例

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

返回值

正常返回值:

返回值

說明

200

服務(wù)器已成功處理了請(qǐng)求。

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

錯(cuò)誤碼

請(qǐng)參考錯(cuò)誤碼