華為云計(jì)算 云知識(shí) 查詢公網(wǎng)NAT網(wǎng)關(guān)列表ListNatGateways
查詢公網(wǎng)NAT網(wǎng)關(guān)列表ListNatGateways

 

接口說明

查詢公網(wǎng) NAT網(wǎng)關(guān) 實(shí)例列表。

約束說明

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

URL
GET  https://nat.cn-north-4.myhuaweicloud.com/v2/{project_id}/nat_gateways 
請(qǐng)求參數(shù)
名稱 類型 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”的值即為Token值。

project_id
 
string path

項(xiàng)目的ID。

id
 
string query

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

enterprise_project_id
 
string query

企業(yè)項(xiàng)目ID。創(chuàng)建公網(wǎng)NAT網(wǎng)關(guān)實(shí)例時(shí),關(guān)聯(lián)的企業(yè)項(xiàng)目ID。

description
 
string query

公網(wǎng)NAT網(wǎng)關(guān)實(shí)例的描述,長度限制為255。

created_at
 
string query

公網(wǎng)NAT網(wǎng)關(guān)實(shí)例的創(chuàng)建時(shí)間,格式是yyyy-mm-dd hh:mm:ss.SSSSSS。

name
 
string query

公網(wǎng)NAT網(wǎng)關(guān)實(shí)例的名字,長度限制為64。 公網(wǎng)NAT網(wǎng)關(guān)實(shí)例的名字僅支持?jǐn)?shù)字、字母、_(下劃線)、-(中劃線)、中文

status
 
Array of strings query

公網(wǎng)NAT網(wǎng)關(guān)實(shí)例的狀態(tài)。

spec
 
Array of strings query

公網(wǎng)NAT網(wǎng)關(guān)實(shí)例的規(guī)格。 取值為: "1":小型,SNAT最大連接數(shù)10000 "2":中型,SNAT最大連接數(shù)50000 "3":大型,SNAT最大連接數(shù)200000 "4":超大型,SNAT最大連接數(shù)1000000

admin_state_up
 
boolean query

解凍/凍結(jié)狀態(tài)。 取值范圍: "true":解凍 "false":凍結(jié)

internal_network_id
 
string query

公網(wǎng)NAT網(wǎng)關(guān)下行口(DVR的下一跳)所屬的network id。

router_id
 
string query

VPC的id。

limit
 
integer query

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

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

查詢公網(wǎng)NAT網(wǎng)關(guān)實(shí)例列表成功

名稱 類型 必選 描述
nat_gateways
 
Array of NatGatewayResponseBody objects

查詢公網(wǎng)NAT網(wǎng)關(guān)實(shí)例列表的響應(yīng)體。 詳見NatGateway字段說明。

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

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

tenant_id
 
string

項(xiàng)目的ID。

name
 
string

公網(wǎng)NAT網(wǎng)關(guān)實(shí)例的名字,長度限制為64。

description
 
string

公網(wǎng)NAT網(wǎng)關(guān)實(shí)例的描述,長度限制為255。

spec
 
string

公網(wǎng)NAT網(wǎng)關(guān)的規(guī)格。 取值為: “1”:小型,SNAT最大連接數(shù)10000 “2”:中型,SNAT最大連接數(shù)50000 “3”:大型,SNAT最大連接數(shù)200000 “4”:超大型,SNAT最大連接數(shù)1000000

status
 
string

公網(wǎng)NAT網(wǎng)關(guān)實(shí)例的狀態(tài)。

admin_state_up
 
boolean

解凍/凍結(jié)狀態(tài)。 取值范圍:

  • "true":解凍
  • "false":凍結(jié)
created_at
 
string

公網(wǎng)NAT網(wǎng)關(guān)實(shí)例的創(chuàng)建時(shí)間,格式是yyyy-mm-dd hh:mm:ss.SSSSSS。

router_id
 
string

VPC的id。

internal_network_id
 
string

公網(wǎng)NAT網(wǎng)關(guān)下行口(DVR的下一跳)所屬的network id。

enterprise_project_id
 
string

企業(yè)項(xiàng)目ID。 創(chuàng)建公網(wǎng)NAT網(wǎng)關(guān)實(shí)例時(shí),關(guān)聯(lián)的企業(yè)項(xiàng)目ID。

session_conf
 
SessionConfiguration object

公網(wǎng)NAT網(wǎng)關(guān)會(huì)話參數(shù)配置。

200 nat_gateways.session_conf
名稱 類型 必選 描述
tcp_session_expire_time
 
integer

TCP會(huì)話過期時(shí)間。

udp_session_expire_time
 
integer

UDP會(huì)話過期時(shí)間。

icmp_session_expire_time
 
integer

ICMP會(huì)話過期時(shí)間。

tcp_time_wait_time
 
integer

TCP連接關(guān)閉時(shí)TIME_WAIT狀態(tài)持續(xù)時(shí)間。

請(qǐng)求示例
示例 1
 
"GET https://{Endpoint}/v2/27e25061336f4af590faeabeb7fcd9a3/nat_gateways?status=ACTIVE"
返回示例
返回碼:200

查詢公網(wǎng)NAT網(wǎng)關(guān)實(shí)例列表成功

示例 1
 
{
"nat_gateways": [
{
"id": "a253be25-ae7c-4013-978b-3c0785eccd63",
"router_id": "b1d81744-5165-48b8-916e-e56626feb88f",
"status": "ACTIVE",
"description": "nat01",
"admin_state_up": true,
"tenant_id": "27e25061336f4af590faeabeb7fcd9a3",
"created_at": "2017-11-15 14:50:39.505112",
"spec": "2",
"internal_network_id": "5930796a-6026-4d8b-8790-6c6bfc9f87e8",
"name": "wj3",
"enterprise_project_id": "0aad99bc-f5f6-4f78-8404-c598d76b0ed2"
},
{
"id": "e824f1b4-4290-4ebc-8322-cfff370dbd1e",
"router_id": "305dc52f-13dd-429b-a2d4-444a1039ba0b",
"status": "ACTIVE",
"description": "1234",
"admin_state_up": true,
"tenant_id": "27e25061336f4af590faeabeb7fcd9a3",
"created_at": "2017-11-17 07:41:07.538062",
"spec": "2",
"internal_network_id": "fc09463b-4ef8-4c7a-93c8-92d9ca6daf9d",
"name": "lyl001",
"enterprise_project_id": "0"
}
]
}
SDK
點(diǎn)擊 NAT網(wǎng)關(guān) (NAT) SDK, 下載SDK或查看SDK文檔。SDK的安裝、認(rèn)證方式等在SDK文檔中對(duì)應(yīng)語言類型的【使用】目錄下。
錯(cuò)誤碼
請(qǐng)參考 錯(cuò)誤碼說明