華為云計(jì)算 云知識(shí) 查詢私網(wǎng)NAT網(wǎng)關(guān)實(shí)例ListPrivateNatsByTags
查詢私網(wǎng)NAT網(wǎng)關(guān)實(shí)例ListPrivateNatsByTags
時(shí)間: 2023-10-12 15:10:54
猜你想看：
實(shí)時(shí)語(yǔ)音識(shí)別 云服務(wù)器配置 CDN是什么意思 視頻點(diǎn)播加速 什么是云桌面

 

接口說(shuō)明
  • 使用標(biāo)簽過(guò)濾 私網(wǎng)NAT網(wǎng)關(guān) 實(shí)例。
  • 標(biāo)簽管理服務(wù)需要提供按標(biāo)簽過(guò)濾私網(wǎng) NAT網(wǎng)關(guān) 服務(wù)實(shí)例并匯總顯示在列表中,需要私網(wǎng)NAT網(wǎng)關(guān)服務(wù)提供查詢能力。
URL
POST  https://nat.cn-north-4.myhuaweicloud.com/v3/{project_id}/private-nat-gateways/resource_instances/action 
請(qǐng)求參數(shù)
名稱 類(lèi)型 IN 必選 描述
X-Auth-Token
 
 string header 是

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

項(xiàng)目的ID。
Body參數(shù)
名稱 類(lèi)型 必選 描述
offset
 
 string 否

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

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

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

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

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

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

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

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

搜索條件key值。
value
 
 string 是

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

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

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

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

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

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

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

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

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

資源列表。
request_id
 
 string 是

請(qǐng)求id。
total_count
 
 integer 是

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

資源詳情。用于擴(kuò)展。默認(rèn)為空。
resource_id
 
 string 是

資源的ID。
resource_name
 
 string 是

資源名稱,資源沒(méi)有名稱時(shí)默認(rèn)為空字符串。
resource_tag
 
 Array of ResourceTag objects 是

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

標(biāo)簽key值。
value
 
 string 是

標(biāo)簽value。
請(qǐng)求示例
示例 1

action為filter的請(qǐng)求體。

 
"POST https://{Endpoint}/v3/cfa563efb77d4b6d9960781d82530fd8/private-nat-gateways/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的請(qǐng)求體。

 
"POST https://{Endpoint}/v3/cfa563efb77d4b6d9960781d82530fd8/private-nat-gateways/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時(shí)的響應(yīng)體
  • 示例2:action為filter時(shí)的響應(yīng)體
示例 1
 
{
"request_id": "a67262f6b7242d63d4ae95e41abf2790",
"total_count": 100
}
示例 2
 
{
"resources": [
{
"resource_detail": null,
"resource_id": "e5ad289f-9c56-4daf-b08b-2e53a983473a",
"resource_name": "nat_gateways",
"tags": [
{
"key": "key1",
"value": "value1"
},
{
"key": "key2",
"value": "value1"
}
]
}
],
"request_id": "a67262f6b7242d63d4ae95e41abf2790",
"total_count": 1
}
SDK
點(diǎn)擊 NAT網(wǎng)關(guān) (NAT) SDK, 下載SDK或查看SDK文檔。SDK的安裝、認(rèn)證方式等在SDK文檔中對(duì)應(yīng)語(yǔ)言類(lèi)型的【使用】目錄下。
錯(cuò)誤碼
請(qǐng)參考 錯(cuò)誤碼說(shuō)明。

猜你喜歡
查詢私網(wǎng)NAT網(wǎng)關(guān)實(shí)例ListPrivateNatsByTags

意見(jiàn)反饋

0/200

提交 取消

提交成功！非常感謝您的反饋，我們會(huì)繼續(xù)努力做到更好 反饋提交失?。≌?qǐng)稍后重試！
相關(guān)專(zhuān)題