華為云計(jì)算 云知識(shí) 查詢中轉(zhuǎn)IP列表ListTransitIps
查詢中轉(zhuǎn)IP列表ListTransitIps

 

接口說(shuō)明

查詢中轉(zhuǎn)IP列表。

約束說(shuō)明

可以在URI后面用‘?’和‘&’添加不同的查詢條件組合。 支持參數(shù)說(shuō)明中所有非必選參數(shù)過(guò)濾,請(qǐng)參考請(qǐng)求樣例。

URL
GET  https://nat.cn-north-4.myhuaweicloud.com/v3/{project_id}/private-nat/transit-ips 
請(qǐng)求參數(shù)
名稱(chēng) 類(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。

limit
 
integer query

功能說(shuō)明:每頁(yè)返回的個(gè)數(shù)。 取值范圍:0~2000。 默認(rèn)值:2000。

marker
 
string query

功能說(shuō)明:分頁(yè)查詢起始的資源ID,為空時(shí)查詢第一頁(yè)。 值從上一次查詢的PageInfo中的next_marker或者previous_marker中獲取。

page_reverse
 
boolean query

是否查詢前一頁(yè)。

id
 
Array of strings query

中轉(zhuǎn)IP的ID。

project_id
 
Array of strings query

項(xiàng)目的ID。

network_interface_id
 
Array of strings query

中轉(zhuǎn)IP的網(wǎng)絡(luò)接口ID。

ip_address
 
Array of strings query

中轉(zhuǎn)IP地址。

gateway_id
 
Array of strings query

中轉(zhuǎn)IP綁定的 私網(wǎng)NAT網(wǎng)關(guān) 實(shí)例的ID。

enterprise_project_id
 
Array of strings query

企業(yè)項(xiàng)目ID。創(chuàng)建中轉(zhuǎn)IP時(shí),關(guān)聯(lián)的企業(yè)項(xiàng)目ID。

virsubnet_id
 
Array of strings query

當(dāng)前租戶子網(wǎng)的ID。

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

查詢中轉(zhuǎn)IP列表成功。

名稱(chēng) 類(lèi)型 必選 描述
transit_ips
 
Array of TransitIp objects

查詢中轉(zhuǎn)IP列表的響應(yīng)體。

page_info
 
PageInfo object

分頁(yè)信息。

request_id
 
string

請(qǐng)求ID。

200 transit_ips
名稱(chēng) 類(lèi)型 必選 描述
id
 
string

中轉(zhuǎn)IP的ID。

project_id
 
string

項(xiàng)目的ID。

network_interface_id
 
string

中轉(zhuǎn)IP的網(wǎng)絡(luò)接口ID。

ip_address
 
string

中轉(zhuǎn)IP的地址。

created_at
 
string

中轉(zhuǎn)IP的創(chuàng)建時(shí)間,遵循UTC時(shí)間,格式是yyyy-mm-ddThh:mm:ssZ

updated_at
 
string

中轉(zhuǎn)IP的更新時(shí)間,遵循UTC時(shí)間,格式是yyyy-mm-ddThh:mm:ssZ

virsubnet_id
 
string

當(dāng)前租戶子網(wǎng)的ID。

tags
 
Array of PrivateTag objects

標(biāo)簽列表。

gateway_id
 
string

中轉(zhuǎn)IP綁定的私網(wǎng) NAT網(wǎng)關(guān) 實(shí)例的ID。

enterprise_project_id
 
string

企業(yè)項(xiàng)目ID。創(chuàng)建中轉(zhuǎn)IP時(shí),關(guān)聯(lián)的企業(yè)項(xiàng)目ID。

200 transit_ips.tags
名稱(chēng) 類(lèi)型 必選 描述
key
 
string

標(biāo)簽key值。

value
 
string

標(biāo)簽value。

200 page_info
名稱(chēng) 類(lèi)型 必選 描述
next_marker
 
string

分頁(yè)查詢結(jié)果中最后一條記錄的ID。通常用于查詢下一頁(yè)。

previous_marker
 
string

分頁(yè)查詢結(jié)果中第一條記錄的ID。通常用于配合page_reverse=true查詢上一頁(yè)。

current_count
 
integer

分頁(yè)查詢資源時(shí),本頁(yè)的實(shí)例的個(gè)數(shù)。

返回示例
返回碼:200

查詢中轉(zhuǎn)IP列表成功。

示例 1
 
{
"transit_ips": [
{
"id": "3faa719d-6d18-4ccb-a5c7-33e65a09663e",
"project_id": "da261828016849188f4dcc2ef94d9da9",
"network_interface_id": "c91c43fb-8d66-48df-bfa9-b89053ac3737",
"enterprise_project_id": "2759da7b-8015-404c-ae0a-a389007b0e2a",
"gateway_id": "521bb3d9-8bed-4c6c-9ee8-669bd0620f76",
"ip_address": "192.168.1.68",
"created_at": "2019-04-29T03:41:59",
"updated_at": "2019-04-29T03:41:59",
"virsubnet_id": "49ee5fb5-75bf-4320-946e-b21ef4c9c9c1",
"tags": [
{
"key": "key1",
"value": "value1"
}
]
},
{
"id": "a2845109-3b2f-4627-b08f-09a726c0a6e7",
"project_id": "da261828016849188f4dcc2ef94d9da9",
"network_interface_id": "adebbdca-8c26-4c14-b34f-3f53cd2c42f2",
"enterprise_project_id": "2759da7b-8015-404c-ae0a-a389007b0e2a",
"gateway_id": "521bb3d9-8bed-4c6c-9ee8-669bd0620f76",
"ip_address": "192.168.1.58",
"created_at": "2019-04-29T02:16:09",
"updated_at": "2019-04-29T02:16:09",
"virsubnet_id": "333e5fb5-75bf-4320-946e-b21ef4c9c2g5",
"tags": [
{
"key": "key1",
"value": "value1"
}
]
}
],
"request_id": "747a911c17067a39692f75ac146fb47e"
}
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ō)明。