華為云計算 云知識 查詢DNAT規(guī)則列表ListPrivateDnats
查詢DNAT規(guī)則列表ListPrivateDnats

 

接口說明

查詢DNAT規(guī)則列表。

約束說明

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

URL
GET  https://nat.cn-north-4.myhuaweicloud.com/v3/{project_id}/private-nat/dnat-rules 
請求參數(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

項目的ID。

limit
 
integer query

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

marker
 
string query

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

page_reverse
 
boolean query

是否查詢前一頁。

id
 
Array of strings query

DNAT規(guī)則的ID。

project_id
 
Array of strings query

項目的ID。

enterprise_project_id
 
Array of strings query

企業(yè)項目ID。創(chuàng)建DNAT規(guī)則時,關(guān)聯(lián)的企業(yè)項目ID。

description
 
Array of strings query

DNAT規(guī)則的描述。

gateway_id
 
Array of strings query

私網(wǎng)NAT網(wǎng)關(guān) 實例的ID。

transit_ip_id
 
Array of strings query

中轉(zhuǎn)IP的ID。

external_ip_address
 
Array of strings query

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

network_interface_id
 
Array of strings query

網(wǎng)絡(luò)接口ID,支持計算、ELB、VIP等實例的網(wǎng)絡(luò)接口。

type
 
Array of strings query

DNAT規(guī)則后端的類型。 取值: COMPUTE:后端為計算實例。 VIP:后端為VIP的實例。 ELB:后端為ELB的實例。 ELBv3:后端為ELBv3的實例。 CUSTOMIZE:后端為自定義IP。

private_ip_address
 
Array of strings query

后端實例的IP私網(wǎng)地址。

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

查詢DNAT規(guī)則列表成功。

名稱 類型 必選 描述
dnat_rules
 
Array of PrivateDnat objects

查詢DNAT規(guī)則列表的響應(yīng)體。

request_id
 
string

請求ID。

page_info
 
PageInfo object

分頁信息。

200 dnat_rules
名稱 類型 必選 描述
id
 
string

DNAT規(guī)則的ID。

project_id
 
string

項目的ID。

description
 
string

DNAT規(guī)則的描述。

transit_ip_id
 
string

中轉(zhuǎn)IP的ID。

gateway_id
 
string

私網(wǎng) NAT網(wǎng)關(guān) 實例的ID。

network_interface_id
 
string

網(wǎng)絡(luò)接口ID,支持計算、ELB、VIP等實例的端口。

type
 
string

DNAT規(guī)則后端的類型。 取值: COMPUTE:后端為計算實例。 VIP:后端為VIP的實例。 ELB:后端為ELB的實例。 ELBv3:后端為ELBv3的實例。 CUSTOMIZE:后端為自定義IP。

protocol
 
string

協(xié)議類型。 目前支持TCP/tcp、UDP/udp、ANY/any。 對應(yīng)協(xié)議號6、17、0。

private_ip_address
 
string

后端實例的私網(wǎng)IP地址。

internal_service_port
 
string

后端實例的端口號。

transit_service_port
 
string

中轉(zhuǎn)IP的端口號。

enterprise_project_id
 
string

企業(yè)項目ID。創(chuàng)建DNAT規(guī)則時,關(guān)聯(lián)的企業(yè)項目ID。

created_at
 
string

DNAT規(guī)則的創(chuàng)建時間,遵循UTC時間,格式是yyyy-mm-ddThh:mm:ssZ。

updated_at
 
string

DNAT規(guī)則的更新時間,遵循UTC時間,格式是yyyy-mm-ddThh:mm:ssZ。

200 page_info
名稱 類型 必選 描述
next_marker
 
string

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

previous_marker
 
string

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

current_count
 
integer

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

返回示例
返回碼:200

查詢DNAT規(guī)則列表成功。

示例 1
 
{
"dnat_rules": [
{
"id": "24dd6bf5-48f2-4915-ad0b-5bb111d39c83",
"project_id": "da261828016849188f4dcc2ef94d9da9",
"description": "aa",
"gateway_id": "0adefb29-a6c2-48a5-8637-2be67fa03fec",
"transit_ip_id": "3faa719d-6d18-4ccb-a5c7-33e65a09663e",
"enterprise_project_id": "2759da7b-8015-404c-ae0a-a389007b0e2a",
"network_interface_id": "dae9393a-b536-491c-a5a2-72edc1104707",
"type": "COMPUTE",
"protocol": "any",
"internal_service_port": "0",
"transit_service_port": "0",
"private_ip_address": "192.168.1.72",
"created_at": "2019-04-29T07:10:01",
"updated_at": "2019-04-29T07:10:01"
},
{
"id": "25dcdb21-97de-43cd-b476-31637a47f05d",
"project_id": "da261828016849188f4dcc2ef94d9da9",
"description": "aa",
"gateway_id": "0adefb29-a6c2-48a5-8637-2be67fa03fec",
"transit_ip_id": "15abdf29-4a68-474c-9963-79c4e6d495d7",
"enterprise_project_id": "2759da7b-8015-404c-ae0a-a389007b0e2a",
"network_interface_id": "9e2f0dbb-68b2-4c4b-9298-fa4f13187976",
"type": "COMPUTE",
"protocol": "any",
"internal_service_port": "0",
"transit_service_port": "0",
"private_ip_address": "192.168.1.99",
"created_at": "2019-04-29T07:15:41",
"updated_at": "2019-04-29T07:15:41"
}
],
"request_id": "a7b00469-5a31-4274-bb10-59167243383e",
"page_info": {
"previous_marker": "14338426-6afe-4019-996b-018008113013",
"current_count": 2
}
}
SDK
點(diǎn)擊 NAT網(wǎng)關(guān) (NAT) SDK, 下載SDK或查看SDK文檔。SDK的安裝、認(rèn)證方式等在SDK文檔中對應(yīng)語言類型的【使用】目錄下。
錯誤碼
請參考 錯誤碼說明。