華為云計算 云知識 更新裸金屬服務(wù)器元數(shù)據(jù)UpdateBaremetalServerMetadata
更新裸金屬服務(wù)器元數(shù)據(jù)UpdateBaremetalServerMetadata

 

功能介紹

更新 裸金屬服務(wù)器 元數(shù)據(jù)。

  • 如果元數(shù)據(jù)中沒有待更新字段,則自動添加該字段。
  • 如果元數(shù)據(jù)中已存在待更新字段,則直接更新字段值。
  • 如果元數(shù)據(jù)中的字段不再請求參數(shù)中,則保持不變。

約束

裸金屬服務(wù)器狀態(tài)(裸金屬服務(wù)器的OS-EXT-STS:vm_state屬性)必須是active、stopped、paused。

調(diào)試

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

URI

POST /v1/{project_id}/baremetalservers/{server_id}/metadata

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

參數(shù)

是否必選

描述

project_id

項目ID。

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

server_id

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

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

請求參數(shù)

表2 請求參數(shù)說明

參數(shù)

是否必選

參數(shù)類型

說明

metadata

Object

用戶自定義metadata鍵值對。

結(jié)構(gòu)體允許為空,取值為空時不更新數(shù)據(jù)。

鍵。

最大長度255個Unicode字符,不能為空。可以為大寫字母(A-Z)、小寫字母(a-z)、數(shù)字(0-9)、中劃線(-)、下劃線(_)、冒號(:)和小數(shù)點(.)。

值。

最大長度為255個Unicode字符。

請求示例

更新ID為cf2a8b97-b5c6-47ef-9714-eb27adf26e5b的裸金屬服務(wù)器的元數(shù)據(jù),自定義metadata鍵值對為key和value。
POST https://{BMS Endpoint}/v1/bbf1946d374b44a0a2a95533562ba954/baremetalservers/cf2a8b97-b5c6-47ef-9714-eb27adf26e5b/metadata
{
    "metadata": {
        "key": "value"
    }
}

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

表3 參數(shù)說明

參數(shù)

是否必選

參數(shù)類型

說明

metadata

Object

用戶自定義metadata鍵值對。

結(jié)構(gòu)體允許為空,取值為空時不更新數(shù)據(jù)。

鍵。

最大長度255個Unicode字符,不能為空??梢詾榇髮懽帜福ˋ-Z)、小寫字母(a-z)、數(shù)字(0-9)、中劃線(-)、下劃線(_)、冒號(:)和小數(shù)點(.)。

值。

最大長度為255個Unicode字符。

響應(yīng)示例

{
    "metadata":{
        "key": "value"
    }
} 

返回值

正常返回值:

返回值

說明

200

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

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

錯誤碼

請參考錯誤碼。