华为云计算 云知识 查询公网NAT网关列表ListNatGateways
查询公网NAT网关列表ListNatGateways

 

接口说明

查询公网 NAT网关 实例列表。

约束说明

可以在URI后面用'?'和'&'添加不同的查询条件组合。支持参数说明中所有非必选参数过滤,请参考请求样例。

URL
GET  https://nat.cn-north-4.myhuaweicloud.com/v2/{project_id}/nat_gateways 
请求参数
名称 类型 IN 必选 描述
X-Auth-Token
 
string header

用户Token。 用户Token也就是调用获取用户Token获取请求认证接口的响应值,该接口是唯一不需要认证的接口。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。

project_id
 
string path

项目的ID。

id
 
string query

公网NAT网关实例的ID。

enterprise_project_id
 
string query

企业项目ID。创建公网NAT网关实例时,关联的企业项目ID。

description
 
string query

公网NAT网关实例的描述,长度限制为255。

created_at
 
string query

公网NAT网关实例的创建时间,格式是yyyy-mm-dd hh:mm:ss.SSSSSS。

name
 
string query

公网NAT网关实例的名字,长度限制为64。 公网NAT网关实例的名字仅支持数字、字母、_(下划线)、-(中划线)、中文

status
 
Array of strings query

公网NAT网关实例的状态。

spec
 
Array of strings query

公网NAT网关实例的规格。 取值为: "1":小型,SNAT最大连接数10000 "2":中型,SNAT最大连接数50000 "3":大型,SNAT最大连接数200000 "4":超大型,SNAT最大连接数1000000

admin_state_up
 
boolean query

解冻/冻结状态。 取值范围: "true":解冻 "false":冻结

internal_network_id
 
string query

公网NAT网关下行口(DVR的下一跳)所属的network id。

router_id
 
string query

VPC的id。

limit
 
integer query

功能说明:每页返回的个数。 取值范围:0~2000。 默认值:2000。

返回参数
返回码: 200

查询公网NAT网关实例列表成功

名称 类型 必选 描述
nat_gateways
 
Array of NatGatewayResponseBody objects

查询公网NAT网关实例列表的响应体。 详见NatGateway字段说明。

200 nat_gateways
名称 类型 必选 描述
id
 
string

公网NAT网关实例的ID。

tenant_id
 
string

项目的ID。

name
 
string

公网NAT网关实例的名字,长度限制为64。

description
 
string

公网NAT网关实例的描述,长度限制为255。

spec
 
string

公网NAT网关的规格。 取值为: “1”:小型,SNAT最大连接数10000 “2”:中型,SNAT最大连接数50000 “3”:大型,SNAT最大连接数200000 “4”:超大型,SNAT最大连接数1000000

status
 
string

公网NAT网关实例的状态。

admin_state_up
 
boolean

解冻/冻结状态。 取值范围:

  • "true":解冻
  • "false":冻结
created_at
 
string

公网NAT网关实例的创建时间,格式是yyyy-mm-dd hh:mm:ss.SSSSSS。

router_id
 
string

VPC的id。

internal_network_id
 
string

公网NAT网关下行口(DVR的下一跳)所属的network id。

enterprise_project_id
 
string

企业项目ID。 创建公网NAT网关实例时,关联的企业项目ID。

session_conf
 
SessionConfiguration object

公网NAT网关会话参数配置。

200 nat_gateways.session_conf
名称 类型 必选 描述
tcp_session_expire_time
 
integer

TCP会话过期时间。

udp_session_expire_time
 
integer

UDP会话过期时间。

icmp_session_expire_time
 
integer

ICMP会话过期时间。

tcp_time_wait_time
 
integer

TCP连接关闭时TIME_WAIT状态持续时间。

请求示例
示例 1
 
"GET https://{Endpoint}/v2/27e25061336f4af590faeabeb7fcd9a3/nat_gateways?status=ACTIVE"
返回示例
返回码:200

查询公网NAT网关实例列表成功

示例 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
点击 NAT网关 (NAT) SDK, 下载SDK或查看SDK文档。SDK的安装、认证方式等在SDK文档中对应语言类型的【使用】目录下。
错误码
请参考 错误码说明

 

上一篇:waf的应用场景 下一篇:查询APIGroup /apis/metrics.k8s.iogetMetricsAPIGroup

NAT网关 NAT 

 

华为云NAT网关(NAT Gateway)提供公网NAT网关(Public NAT Gateway)和私网NAT网关(Private NAT Gateway)两个功能。 公网NAT网关能够为VPC内的弹性云服务器提供SNAT和DNAT功能,通过灵活简易的配置,即可轻松构建VPC的公网出入口。 私网NAT网关能够为虚拟私有云内的云主机提供网络地址转换服务,使多个云主机可以共享私网IP访问用户本地数据中心(IDC)或其他虚拟私有云,同时,也支持云主机面向私网提供服务。