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

 

功能介紹

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

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

如果元數(shù)據(jù)中包含了敏感數(shù)據(jù),您應(yīng)當(dāng)采取適當(dāng)?shù)拇胧﹣肀Wo(hù)敏感數(shù)據(jù),比如限制訪問范圍、加密等。

接口約束

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

調(diào)試

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

URI

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

表1 參數(shù)說明

參數(shù)

是否必選

描述

project_id

項(xiàng)目ID。

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

server_id

云服務(wù)器ID。

請求消息

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

參數(shù)

是否必選

參數(shù)類型

說明

metadata

Object

用戶自定義metadata鍵值對。

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

鍵。

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

值。

最大長度為255個Unicode字符。

響應(yīng)消息

表3 參數(shù)說明

參數(shù)

參數(shù)類型

說明

metadata

Object

用戶自定義metadata鍵值對。

請求示例

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

POST https://{endpoint}/v1/{project_id}/cloudservers/{server_id}/metadata

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

響應(yīng)示例

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

返回值

請參考通用請求返回值。