華為云計算 云知識 修改云服務(wù)器指定Key的元數(shù)據(jù)NovaUpdateServerMetadataItem
修改云服務(wù)器指定Key的元數(shù)據(jù)NovaUpdateServerMetadataItem

 

功能介紹

設(shè)置 云服務(wù)器 指定key的元數(shù)據(jù)。

  • 如果元數(shù)據(jù)中沒有待更新字段,則自動添加該字段。
  • 如果元數(shù)據(jù)中已存在待更新字段,則直接更新字段值。

接口約束

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

調(diào)試

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

URI

PUT /v2.1/{project_id}/servers/{server_id}/metadata/{key}

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

參數(shù)

是否必選

描述

project_id

項目ID。

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

server_id

云服務(wù)器ID。

key

待修改的云服務(wù)器metadata鍵值。

請求消息

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

表2 請求參數(shù)

參數(shù)

是否必選

參數(shù)類型

描述

meta

Object

用戶自定義metadata鍵值對。

鍵。

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

值。

最大長度為255個Unicode字符。

響應(yīng)消息

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

參數(shù)

參數(shù)類型

描述

meta

Object

用戶自定義metadata鍵值對。

請求示例

設(shè)置指定云服務(wù)器的指定key的元數(shù)據(jù)。

PUT https://{endpoint}/v2.1/{project_id}/servers/{server_id}/metadata/{key}

{
    "meta":{
        "key":"value"
    }
} 

響應(yīng)示例

{
    "meta":{
        "key":"value"
    }
} 

返回值

請參考通用請求返回值。