華為云計算 云知識 查詢中轉(zhuǎn)IP實例ListTransitIpsByTags
查詢中轉(zhuǎn)IP實例ListTransitIpsByTags
時間: 2023-10-12 15:21:59
猜你想看：
實時語音識別 云服務(wù)器配置 CDN是什么意思 視頻點播加速 什么是云桌面

 

接口說明
  • 使用標簽過濾中轉(zhuǎn)IP實例。
  • 標簽管理服務(wù)需要提供按標簽過濾中轉(zhuǎn)IP服務(wù)實例并匯總顯示在列表中,需要中轉(zhuǎn)IP服務(wù)提供查詢能力。
URL
POST  https://nat.cn-north-4.myhuaweicloud.com/v3/{project_id}/transit-ips/resource_instances/action 
請求參數(shù)
名稱 類型 IN 必選 描述
X-Auth-Token
 
 string header 是

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

項目的ID。
Body參數(shù)
名稱 類型 必選 描述
offset
 
 string 否

索引位置, 從offset指定的下一條數(shù)據(jù)開始查詢。 查詢第一頁數(shù)據(jù)時,不需要傳入此參數(shù),查詢后續(xù)頁碼數(shù)據(jù)時,將查詢前一頁數(shù)據(jù)時響應(yīng)體中的值帶入此參數(shù)(action為count時無此參數(shù))如果action為filter默認為0,必須為數(shù)字,不能為負數(shù)。
limit
 
 string 否

查詢記錄數(shù)(action為count時無此參數(shù))如果action為filter默認為1000,limit最多為1000,不能為負數(shù),最小值為1。
action
 
 string 是

操作標識(僅限于filter,count):filter(過濾),count(查詢總條數(shù)) 如果是filter就是分頁查詢,如果是count只需按照條件將總條數(shù)返回即可。
matches
 
 Array of Match objects 否

搜索字段,key為要匹配的字段,如resource_name等。value為匹配的值。此字段為固定字典值。 根據(jù)不同的字段確認是否需要模糊匹配,如resource_name默認為模糊搜索(不區(qū)分大小寫),如果value為空字符串精確匹配。resource_id為精確匹配。第一期只做resource_name,后續(xù)在擴展。
not_tags
 
 Array of Tags objects 否

不包含標簽,最多包含10個key,每個key下面的value最多10個, 結(jié)構(gòu)體不能缺失,key不能為空或者空字符串。Key不能重復(fù),同一個key中values不能重復(fù)。返回不包含標簽的資源列表,key之間是與的關(guān)系,key-value結(jié)構(gòu)中value是或的關(guān)系。無過濾條件時返回全量數(shù)據(jù)。
tags
 
 Array of Tags objects 否

包含標簽,最多包含10個key,每個key下面的value最多10個,結(jié)構(gòu)體不能缺失,key不能為空或者空字符串。Key不能重復(fù),同一個key中values不能重復(fù)。返回包含所有標簽的資源列表,key之間是與的關(guān)系,key-value結(jié)構(gòu)中value是或的關(guān)系。無tag過濾條件時返回全量數(shù)據(jù)。
tags_any
 
 Array of Tags objects 否

包含任意標簽,最多包含10個key,每個key下面的value最多10個,結(jié)構(gòu)體不能缺失,key不能為空或者空字符串。Key不能重復(fù),同一個key中values不能重復(fù)。返回包含任意標簽的資源列表,key之間是或的關(guān)系,key-value結(jié)構(gòu)中value是或的關(guān)系。無過濾條件時返回全量數(shù)據(jù)。
not_tags_any
 
 Array of Tags objects 否

不包含任意標簽,最多包含10個key,每個key下面的value最多10個,結(jié)構(gòu)體不能缺失,key不能為空或者空字符串。Key不能重復(fù),同一個key中values不能重復(fù)。返回不包含任意標簽的資源列表,key之間是或的關(guān)系,key-value結(jié)構(gòu)中value是或的關(guān)系。無過濾條件時返回全量數(shù)據(jù)。
參數(shù)：
matches
名稱 類型 必選 描述
key
 
 string 是

搜索條件key值。
value
 
 string 是

搜索條件value。
參數(shù)：
not_tags
名稱 類型 必選 描述
key
 
 string 是

鍵。最大長度128個unicode字符。搜索時不對此參數(shù)做校驗,key不能為空或者空字符串,不能為空格,校驗和使用之前先trim 前后空格。
values
 
 Array of strings 是

值列表。每個值最大長度255個unicode字符。
參數(shù)：
tags
名稱 類型 必選 描述
key
 
 string 是

鍵。最大長度128個unicode字符。搜索時不對此參數(shù)做校驗,key不能為空或者空字符串,不能為空格,校驗和使用之前先trim 前后空格。
values
 
 Array of strings 是

值列表。每個值最大長度255個unicode字符。
參數(shù)：
tags_any
名稱 類型 必選 描述
key
 
 string 是

鍵。最大長度128個unicode字符。搜索時不對此參數(shù)做校驗,key不能為空或者空字符串,不能為空格,校驗和使用之前先trim 前后空格。
values
 
 Array of strings 是

值列表。每個值最大長度255個unicode字符。
參數(shù)：
not_tags_any
名稱 類型 必選 描述
key
 
 string 是

鍵。最大長度128個unicode字符。搜索時不對此參數(shù)做校驗,key不能為空或者空字符串,不能為空格,校驗和使用之前先trim 前后空格。
values
 
 Array of strings 是

值列表。每個值最大長度255個unicode字符。
返回參數(shù)
返回碼: 200
  • 查詢操作成功。
  • 示例1:action為count時的響應(yīng)體
  • 示例2:action為filter時的響應(yīng)體
名稱 類型 必選 描述
resources
 
 Array of Resource objects 是

資源列表。
request_id
 
 string 是

請求id。
total_count
 
 integer 是

總記錄數(shù)。
200 resources
名稱 類型 必選 描述
resource_detail
 
 resource_detail object 是

資源詳情。用于擴展。默認為空。
resource_id
 
 string 是

資源的ID。
resource_name
 
 string 是

資源名稱,資源沒有名稱時默認為空字符串。
resource_tag
 
 Array of ResourceTag objects 是

標簽列表,沒有標簽?zāi)J為空數(shù)組。
200 resources.resource_tag
名稱 類型 必選 描述
key
 
 string 是

標簽key值。
value
 
 string 是

標簽value。
請求示例
示例 1

action為filter的請求體。

 
"POST https://{Endpoint}/v3/cfa563efb77d4b6d9960781d82530fd8/transit-ips/resource_instances/action"
 
{ "offset": "10", "limit": "10", "action": "filter", "matches": [ { "key": "resource_name", "value": "resource1" } ], "not_tags": [ { "key": "key1", "values": [ "*value1", "value2" ] } ], "tags": [ { "key": "key1", "values": [ "*value1", "value2" ] } ], "tags_any": [ { "key": "key1", "values": [ "value1", "value2" ] } ], "not_tags_any": [ { "key": "key1", "values": [ "value1", "value2" ] } ] }
示例 2

action為count的請求體。

 
"POST https://{Endpoint}/v3/cfa563efb77d4b6d9960781d82530fd8/transit-ips/resource_instances/action"
 
{ "action": "count", "not_tags": [ { "key": "key1", "values": [ "value1", "*value2" ] } ], "tags": [ { "key": "key1", "values": [ "value1", "value2" ] }, { "key": "key2", "values": [ "value1", "value2" ] } ], "tags_any": [ { "key": "key1", "values": [ "value1", "value2" ] } ], "not_tags_any": [ { "key": "key1", "values": [ "value1", "value2" ] } ], "matches": [ { "key": "resource_name", "value": "resource1" } ] }
返回示例
返回碼：200
  • 查詢操作成功。
  • 示例1:action為count時的響應(yīng)體
  • 示例2:action為filter時的響應(yīng)體
示例 1
 
{
"request_id": "d70aabc854d3d301f9bb106e6b70ac99",
"total_count": 100
}
示例 2
 
{
"resources": [
{
"resource_detail": null,
"resource_id": "ae33be9b-d2c0-441b-a8d0-f6dafedf1778",
"resource_name": "transit_ips",
"tags": [
{
"key": "key1",
"value": "value1"
},
{
"key": "key2",
"value": "value1"
}
]
}
],
"request_id": "9e47d9476cfd346f864cb77acb274185",
"total_count": 1
}
SDK
點擊  NAT網(wǎng)關(guān)  (NAT) SDK, 下載SDK或查看SDK文檔。SDK的安裝、認證方式等在SDK文檔中對應(yīng)語言類型的【使用】目錄下。
錯誤碼
請參考 錯誤碼說明。

 

查詢中轉(zhuǎn)IP實例ListTransitIpsByTags

意見反饋

0/200

提交 取消

提交成功！非常感謝您的反饋，我們會繼續(xù)努力做到更好 反饋提交失??！請稍后重試！