華為云計(jì)算 云知識(shí) 查詢SNAT規(guī)則列表ListNatGatewaySnatRules
查詢SNAT規(guī)則列表ListNatGatewaySnatRules

 

接口說明

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

約束說明

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

URL
GET  https://nat.cn-north-4.myhuaweicloud.com/v2/{project_id}/snat_rules 
請(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。

admin_state_up
 
boolean query

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

cidr
 
string query

可以是網(wǎng)段或者主機(jī)格式,與network_id參數(shù)二選一。 Source_type=0時(shí),cidr必須是vpc子網(wǎng)網(wǎng)段的子集(不能相等); Source_type=1時(shí),cidr必須指定專線側(cè)網(wǎng)段。

limit
 
integer query

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

floating_ip_address
 
string query

功能說明: 彈性公網(wǎng)IP ,多個(gè)彈性 公網(wǎng)IP 使用逗號(hào)分隔。 取值范圍:最大長(zhǎng)度1024字節(jié)。

floating_ip_id
 
string query

功能說明:彈性公網(wǎng)IP的id,多個(gè)彈性公網(wǎng)IP使用逗號(hào)分隔。 取值范圍:最大長(zhǎng)度4096字節(jié)。

id
 
string query

SNAT規(guī)則的ID。

description
 
string query

SNAT規(guī)則的描述,長(zhǎng)度限制為255。

created_at
 
string query

SNAT規(guī)則的創(chuàng)建時(shí)間,格式是yyyy-mm-dd hh:mm:ss.SSSSSS。

nat_gateway_id
 
Array of strings query

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

network_id
 
string query

規(guī)則使用的網(wǎng)絡(luò)id。與cidr參數(shù)二選一。

source_type
 
integer query

0:VPC側(cè),可以指定network_id 或者cidr 1:專線側(cè),只能指定cidr 不輸入默認(rèn)為0(VPC)

status
 
string query

功能說明:SNAT規(guī)則的狀態(tài)。

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

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

名稱 類型 必選 描述
snat_rules
 
Array of NatGatewaySnatRuleResponseBody objects

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

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

SNAT規(guī)則的ID。

tenant_id
 
string

項(xiàng)目的ID。

nat_gateway_id
 
string

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

cidr
 
string

cidr,可以是網(wǎng)段或者主機(jī)格式,與network_id參數(shù)二選一。 Source_type=0時(shí),cidr必須是vpc 子網(wǎng)網(wǎng)段的子集(不能相等); Source_type=1時(shí),cidr必須指定專線側(cè)網(wǎng)段。

source_type
 
integer

0:VPC側(cè),可以指定network_id 或者cidr 1:專線側(cè),只能指定cidr 不輸入默認(rèn)為0(VPC)

floating_ip_id
 
string

功能說明:彈性公網(wǎng)IP的id,多個(gè)彈性公網(wǎng)IP使用逗號(hào)分隔。 取值范圍:最大長(zhǎng)度4096字節(jié)。

description
 
string

SNAT規(guī)則的描述,長(zhǎng)度限制為255。

status
 
string

功能說明:SNAT規(guī)則的狀態(tài)。

created_at
 
string

SNAT規(guī)則的創(chuàng)建時(shí)間,格式是yyyy-mm-dd hh:mm:ss.SSSSSS。

network_id
 
string

規(guī)則使用的網(wǎng)絡(luò)id。與cidr參數(shù)二選一。

admin_state_up
 
boolean

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

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

功能說明:彈性公網(wǎng)IP,多個(gè)彈性公網(wǎng)IP使用逗號(hào)分隔。 取值范圍:最大長(zhǎng)度1024字節(jié)。

freezed_ip_address
 
string

功能說明:凍結(jié)的彈性公網(wǎng)IP,多個(gè)凍結(jié)的彈性公網(wǎng)IP使用逗號(hào)分隔。 取值范圍:最大長(zhǎng)度1024字節(jié)。

請(qǐng)求示例
示例 1
 
"GET https://{Endpoint}/v2/d199ba7e0ba64899b2e81518104b1526/snat_rules?limit=2"
返回示例
返回碼:200

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

示例 1
 
{
"snat_rules": [
{
"floating_ip_id": "bf99c679-9f41-4dac-8513-9c9228e713e1",
"status": "ACTIVE",
"nat_gateway_id": "cda3a125-2406-456c-a11f-598e10578541",
"admin_state_up": true,
"network_id": "9a469561-daac-4c94-88f5-39366e5ea193",
"source_type": 0,
"tenant_id": "d199ba7e0ba64899b2e81518104b1526",
"created_at": "2017-11-15 15:44:42.595173",
"id": "79195d50-0271-41f1-bded-4c089b2502ff",
"floating_ip_address": "5.21.11.242",
"freezed_ip_address": "",
"description": "my snat rule 01"
},
{
"floating_ip_id": "6e496fba-abe9-4f5e-9406-2ad8c809ac8c",
"status": "ACTIVE",
"nat_gateway_id": "e824f1b4-4290-4ebc-8322-cfff370dbd1e",
"admin_state_up": true,
"network_id": "97e89905-f9c8-4ae3-9856-392b0b2fbe7f",
"source_type": 0,
"tenant_id": "d199ba7e0ba64899b2e81518104b1526",
"created_at": "2017-11-17 07:43:44.830845",
"id": "4a1a10d7-0d9f-4846-8cda-24cffeffef5c",
"floating_ip_address": "5.21.11.142,5.21.11.143",
"freezed_ip_address": "5.21.11.142",
"description": "my snat rule 01"
}
]
}
SDK
點(diǎn)擊 NAT網(wǎng)關(guān) (NAT) SDK, 下載SDK或查看SDK文檔。SDK的安裝、認(rèn)證方式等在SDK文檔中對(duì)應(yīng)語(yǔ)言類型的【使用】目錄下。
錯(cuò)誤碼
請(qǐng)參考 錯(cuò)誤碼說明。