華為云計(jì)算 云知識 批量添加刪除中轉(zhuǎn)IP標(biāo)簽BatchCreateDeleteTransitIpTags
批量添加刪除中轉(zhuǎn)IP標(biāo)簽BatchCreateDeleteTransitIpTags

 

接口說明
  • 為指定中轉(zhuǎn)IP實(shí)例批量添加或刪除標(biāo)簽
  • 標(biāo)簽管理服務(wù)需要使用該接口批量管理中轉(zhuǎn)IP實(shí)例的標(biāo)簽。
  • 一個(gè)中轉(zhuǎn)IP上最多有10個(gè)標(biāo)簽。
約束說明

此接口為冪等接口:

  • 創(chuàng)建時(shí)如果請求體中存在重復(fù)key則報(bào)錯(cuò)。
  • 創(chuàng)建時(shí),不允許設(shè)置重復(fù)key數(shù)據(jù),如果 數(shù)據(jù)庫 已存在該key,就覆蓋value的值。
  • 刪除時(shí),如果刪除的標(biāo)簽不存在,默認(rèn)處理成功,刪除時(shí)不對標(biāo)簽字符集范圍做校驗(yàn)。
  • 刪除時(shí)tags結(jié)構(gòu)體不能缺失,key不能為空,或者空字符串。
URL
POST  https://nat.cn-north-4.myhuaweicloud.com/v3/{project_id}/transit-ips/{resource_id}/tags/action 
請求參數(shù)
名稱 類型 IN 必選 描述
X-Auth-Token
 
string header

用戶Token。 用戶Token也就是調(diào)用獲取用戶Token獲取請求認(rèn)證接口的響應(yīng)值,該接口是唯一不需要認(rèn)證的接口。 請求響應(yīng)成功后在響應(yīng)消息頭中包含的“X-Subject-Token”的值即為Token值。

project_id
 
string path

項(xiàng)目的ID。

resource_id
 
string path

中轉(zhuǎn)IP的ID。

Body參數(shù)
名稱 類型 必選 描述
action
 
string

功能說明:操作標(biāo)識。 取值范圍: create(創(chuàng)建) delete(刪除)

tags
 
Array of Tag objects

標(biāo)簽列表。

參數(shù):
tags
名稱 類型 必選 描述
key
 
string

鍵。最大長度128個(gè)unicode字符。key不能為空。

value
 
string

值。每個(gè)值最大長度255個(gè)unicode字符。

返回參數(shù)
返回碼: 204

批量添加或刪除操作成功。

請求示例
示例 1

批量添加中轉(zhuǎn)IP標(biāo)簽。

 
"POST https://{Endpoint}/v3/cfa563efb77d4b6d9960781d82530fd8/transit-ips/56121618-fb0a-4a51-aff0-e2eb9cba4c73/tags/action"
 
{ "action": "create", "tags": [ { "key": "key1", "value": "value1" }, { "key": "key2", "value": "value2" } ] }
示例 2

批量刪除中轉(zhuǎn)IP標(biāo)簽。

 
"POST https://{Endpoint}/v3/cfa563efb77d4b6d9960781d82530fd8/transit-ips/56121618-fb0a-4a51-aff0-e2eb9cba4c73/tags/action"
 
{ "action": "delete", "tags": [ { "key": "key1", "value": "value1" }, { "key": "key2", "value": "value2" } ] }
SDK
點(diǎn)擊  NAT網(wǎng)關(guān)  (NAT) SDK, 下載SDK或查看SDK文檔。SDK的安裝、認(rèn)證方式等在SDK文檔中對應(yīng)語言類型的【使用】目錄下。
錯(cuò)誤碼
請參考 錯(cuò)誤碼說明。