華為云計(jì)算 云知識(shí) 更新云服務(wù)器元數(shù)據(jù)NovaUpdateServerMetadata
更新云服務(wù)器元數(shù)據(jù)NovaUpdateServerMetadata

 

功能介紹

更新 云服務(wù)器 元數(shù)據(jù)。

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

接口約束

云服務(wù)器狀態(tài)(云服務(wù)器的OS-EXT-STS:vm_state屬性)必須是active,stopped,paused或者suspended。

調(diào)試

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

URI

POST /v2.1/{project_id}/servers/{server_id}/metadata

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

參數(shù)

是否必選

描述

project_id

項(xiàng)目ID。

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

server_id

云服務(wù)器ID。

請(qǐng)求消息

請(qǐng)求參數(shù)如表2所示。
表2 請(qǐng)求參數(shù)

參數(shù)

是否必選

參數(shù)類型

描述

metadata

Object

用戶自定義metadata鍵值對(duì)。

鍵。

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

值。

最大長(zhǎng)度為255個(gè)Unicode字符。

響應(yīng)消息

響應(yīng)參數(shù)如表3所示。
表3 響應(yīng)參數(shù)

參數(shù)

參數(shù)類型

描述

metadata

Object

用戶自定義metadata鍵值對(duì)。

請(qǐng)求示例

更新指定云服務(wù)器元數(shù)據(jù)為自定義的鍵值對(duì)。

POST https://{endpoint}/v2.1/{project_id}/servers/{server_id}/metadata
{
    "metadata": {
        "key": "value"
    }
}

響應(yīng)示例

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

返回值

請(qǐng)參考通用請(qǐng)求返回值