查询SNAT规则列表ListPrivateSnats
接口说明
查询SNAT规则列表。
URL
GET https://nat.cn-north-4.myhuaweicloud.com/v3/{project_id}/private-nat/snat-rules
请求参数
| 名称 | 类型 | IN | 必选 | 描述 |
|---|---|---|---|---|
|
X-Auth-Token
|
string | header | 是 |
用户Token。 用户Token也就是调用获取用户Token获取请求认证接口的响应值,该接口是唯一不需要认证的接口。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 |
|
project_id
|
string | path | 是 |
项目的ID。 |
|
limit
|
integer | query | 否 |
功能说明:每页返回的个数。 取值范围:0~2000。 默认值:2000。 |
|
marker
|
string | query | 否 |
功能说明:分页查询起始的资源ID,为空时查询第一页。 值从上一次查询的PageInfo中的next_marker或者previous_marker中获取。 |
|
page_reverse
|
boolean | query | 否 |
是否查询前一页。 |
|
id
|
Array of strings | query | 否 |
SNAT规则的ID。 |
|
project_id
|
Array of strings | query | 否 |
项目的ID。 |
|
description
|
Array of strings | query | 否 |
SNAT规则的描述。 |
|
gateway_id
|
Array of strings | query | 否 |
私网NAT网关 实例的ID。 |
|
cidr
|
Array of strings | query | 否 |
规则匹配的CIDR。 |
|
virsubnet_id
|
Array of strings | query | 否 |
规则匹配的子网的ID。 |
|
transit_ip_id
|
Array of strings | query | 否 |
中转IP的ID。 |
|
transit_ip_address
|
Array of strings | query | 否 |
中转IP地址。 |
|
enterprise_project_id
|
Array of strings | query | 否 |
企业项目ID。创建SNAT规则时,关联的企业项目ID。 |
返回参数
返回码: 200
查询SNAT规则列表成功。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
|
snat_rules
|
Array of PrivateSnat objects | 否 |
查询SNAT规则列表的响应体。 |
|
page_info
|
PageInfo object | 否 |
分页信息。 |
|
request_id
|
string | 否 |
请求ID。 |
200 snat_rules
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
|
id
|
string | 否 |
SNAT规则的ID。 |
|
project_id
|
string | 否 |
项目的ID。 |
|
gateway_id
|
string | 否 |
私网 NAT网关 实例的ID。 |
|
cidr
|
string | 否 |
功能说明:规则匹配的CIDR。 取值约束:
|
|
virsubnet_id
|
string | 否 |
功能说明:规则匹配的子网的ID。 取值约束:与cidr参数二选一。 |
|
description
|
string | 否 |
SNAT规则的描述。 |
|
transit_ip_associations
|
Array of AssociatedTransitIp objects | 否 |
关联的中转IP详情列表。 |
|
created_at
|
string | 否 |
SNAT规则的创建时间,遵循UTC时间,格式是yyyy-mm-ddThh:mm:ssZ。 |
|
updated_at
|
string | 否 |
SNAT规则的更新时间,遵循UTC时间,格式是yyyy-mm-ddThh:mm:ssZ。 |
|
enterprise_project_id
|
string | 否 |
企业项目id |
200 snat_rules.transit_ip_associations
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
|
transit_ip_id
|
string | 否 |
中转IP的ID。 |
|
transit_ip_address
|
string | 否 |
中转IP地址。 |
200 page_info
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
|
next_marker
|
string | 否 |
分页查询结果中最后一条记录的ID。通常用于查询下一页。 |
|
previous_marker
|
string | 否 |
分页查询结果中第一条记录的ID。通常用于配合page_reverse=true查询上一页。 |
|
current_count
|
integer | 否 |
分页查询资源时,本页的实例的个数。 |
返回示例
返回码：200
查询SNAT规则列表成功。
示例 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"
}
"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网关 (NAT) SDK, 下载SDK或查看SDK文档。SDK的安装、认证方式等在SDK文档中对应语言类型的【使用】目录下。
错误码
请参考 错误码说明。
