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

 

接口說明

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

URL
GET  https://nat.cn-north-4.myhuaweicloud.com/v3/{project_id}/private-nat/snat-rules 
請求參數(shù)
名稱 類型 IN 必選 描述
X-Auth-Token
 
string header

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

project_id
 
string path

項目的ID。

limit
 
integer query

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

marker
 
string query

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

page_reverse
 
boolean query

是否查詢前一頁。

id
 
Array of strings query

SNAT規(guī)則的ID。

project_id
 
Array of strings query

項目的ID。

description
 
Array of strings query

SNAT規(guī)則的描述。

gateway_id
 
Array of strings query

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

cidr
 
Array of strings query

規(guī)則匹配的CIDR。

virsubnet_id
 
Array of strings query

規(guī)則匹配的子網(wǎng)的ID。

transit_ip_id
 
Array of strings query

中轉(zhuǎn)IP的ID。

transit_ip_address
 
Array of strings query

中轉(zhuǎn)IP地址。

enterprise_project_id
 
Array of strings query

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

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

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

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

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

page_info
 
PageInfo object

分頁信息。

request_id
 
string

請求ID。

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

SNAT規(guī)則的ID。

project_id
 
string

項目的ID。

gateway_id
 
string

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

cidr
 
string

功能說明:規(guī)則匹配的CIDR。 取值約束:

  • 與virsubnet_id參數(shù)二選一。
  • cidr不能與已有snat規(guī)則的網(wǎng)段相同。
virsubnet_id
 
string

功能說明:規(guī)則匹配的子網(wǎng)的ID。 取值約束:與cidr參數(shù)二選一。

description
 
string

SNAT規(guī)則的描述。

transit_ip_associations
 
Array of AssociatedTransitIp objects

關(guān)聯(lián)的中轉(zhuǎn)IP詳情列表。

created_at
 
string

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

updated_at
 
string

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

enterprise_project_id
 
string

企業(yè)項目id

200 snat_rules.transit_ip_associations
名稱 類型 必選 描述
transit_ip_id
 
string

中轉(zhuǎn)IP的ID。

transit_ip_address
 
string

中轉(zhuǎn)IP地址。

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

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

previous_marker
 
string

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

current_count
 
integer

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

返回示例
返回碼:200

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

示例 1
 
{
"snat_rules": [
{
"id": "8a522ff9-8158-494b-83cd-533b045700e6",
"project_id": "cfa563efb77d4b6d9960781d82530fd8",
"description": "snat rule description",
"gateway_id": "80da6f26-94eb-4537-97f0-5a56f4d04cfb",
"cidr": "",
"virsubnet_id": "95df1b88-d9bc-4edd-a808-a771dd4ded32",
"transit_ip_associations": [
{
"transit_ip_id": "bbe7c2e7-3bad-445b-a067-b30acce66053",
"transit_ip_address": "172.20.1.98"
}
],
"created_at": "2019-10-22T03:33:07",
"updated_at": "2019-10-22T03:33:07"
},
{
"id": "af4dbb83-7ca0-4ed1-b28b-668c1f9c6b81",
"project_id": "cfa563efb77d4b6d9960781d82530fd8",
"description": "snat rule description",
"gateway_id": "80da6f26-94eb-4537-97f0-5a56f4d04cfb",
"cidr": "",
"virsubnet_id": "5b9ea497-727d-4ad0-a99e-3984b3f5aaed",
"transit_ip_associations": [
{
"transit_ip_id": "36a3049a-1682-48b3-b1cf-cb986a3350ef",
"transit_ip_address": "172.20.1.10"
}
],
"created_at": "2019-10-22T03:31:19",
"updated_at": "2019-10-22T03:31:19"
}
],
"page_info": {
"next_marker": "af4dbb83-7ca0-4ed1-b28b-668c1f9c6b81",
"previous_marker": "8a522ff9-8158-494b-83cd-533b045700e6",
"current_count": 2
},
"request_id": "69806207-62e3-4950-b463-ff5c1779b714"
}
SDK
點擊 NAT網(wǎng)關(guān) (NAT) SDK, 下載SDK或查看SDK文檔。SDK的安裝、認證方式等在SDK文檔中對應(yīng)語言類型的【使用】目錄下。
錯誤碼
請參考 錯誤碼說明