華為云計算 云知識 批量添加刪除鏡像標(biāo)簽BatchAddOrDeleteTags
批量添加刪除鏡像標(biāo)簽BatchAddOrDeleteTags

 

功能介紹

該接口用于為指定 鏡像 批量添加/更新、刪除標(biāo)簽。

約束與限制

  • 每個標(biāo)簽由鍵值對組成,標(biāo)簽的key的長度不超過36個字符,value的長度不超過43個字符。key不能為空或者空白字符串,value不能為空,但可以是空白字符串。
  • 單個鏡像最多添加10個標(biāo)簽。
  • 請求體中的多個標(biāo)簽的key不允許重復(fù)。
  • 此接口為冪等接口:

    創(chuàng)建時,如果創(chuàng)建的標(biāo)簽已經(jīng)存在,即key相同而value不同,則更新對應(yīng)標(biāo)簽;如果創(chuàng)建的標(biāo)簽已經(jīng)存在,key/value均相同,則不進行重復(fù)添加,視為添加成功。

    刪除時,如果指定的標(biāo)簽不存在,則默認(rèn)視為刪除成功。

  • 批量刪除時對key、value的限制:

    刪除時,對標(biāo)簽的key、value不做字符集范圍校驗,key不允許為空或空白字符串;value為可選,且不對value做校驗。如果要刪除的標(biāo)簽不存在,視為刪除成功,不報錯。刪除時,對標(biāo)簽的key、value做長度校驗,標(biāo)簽的key不超過127,value不超過255。

調(diào)試

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

URI

POST /v2/{project_id}/images/{image_id}/tags/action

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

參數(shù)

是否必選

參數(shù)類型

描述

project_id

String

項目ID

image_id

String

鏡像ID

請求消息

  • 請求參數(shù)

    參數(shù)

    是否必選

    參數(shù)類型

    描述

    tags

    Array of objects

    要操作的標(biāo)簽列表。詳情請參見表2。

    action

    String

    要進行的標(biāo)簽操作,區(qū)分大小寫。支持create、delete,分別用于批量地創(chuàng)建/更新、刪除標(biāo)簽。

    表2 tags數(shù)據(jù)結(jié)構(gòu)說明

    參數(shù)

    是否必選

    參數(shù)類型

    描述

    key

    String

    標(biāo)簽的鍵,鍵不能為空。

    value

    String

    標(biāo)簽的值。

請求示例

  • 批量添加鏡像標(biāo)簽,其中,標(biāo)簽鍵為“key1”對應(yīng)的值為“value1”、標(biāo)簽鍵為“key2”對應(yīng)的值為“value2”。
    POST https://{Endpoint}/v2/fd73a4a14a4a4dfb9771a8475e5198ea/images/67e17426-359e-49fb-aa12-0bd1756ec240/tags/action
    
    {
       "tags": [{
          "value": "value1",
          "key": "key1"
       },
       {
          "value": "value2",
          "key": "key2"
       },
       {
          "value": "",
          "key": "key3"
       }],
       "action": "create"
    }
    
  • 批量刪除鏡像標(biāo)簽,其中,標(biāo)簽鍵為“key1”對應(yīng)的值為“value1”、標(biāo)簽鍵為“key2”對應(yīng)的值為“value2”。
    POST https://{Endpoint}/v2/fd73a4a14a4a4dfb9771a8475e5198ea/images/67e17426-359e-49fb-aa12-0bd1756ec240/tags/action
    
    {
       "tags": [{
          "value": "value1",
          "key": "key1"
       },
       {
          "value": "value2",
          "key": "key2"
       },
       {
          "value": "",
          "key": "key3"
       }],
          "action": "delete"
    }
    

響應(yīng)消息

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

  • 響應(yīng)樣例
    STATUS CODE 204

返回值

  • 正常

    204

  • 異常

    返回值

    說明

    400 Bad Request

    請求錯誤。

    401 Unauthorized

    鑒權(quán)失敗。

    403 Forbidden

    沒有操作權(quán)限。

    404 Not Found

    找不到資源。

    500 Internal Server Error

    服務(wù)內(nèi)部錯誤。

    503 Service Unavailable

    服務(wù)不可用。