文档首页/NAT网关 NAT/API参考/API（公网NAT网关）/公网NAT网关/查询公网NAT网关列表 - ListNatGateways
更新时间：2025-12-25 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询公网NAT网关列表 - ListNatGateways

功能介绍

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

接口约束

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

调用方法

请参见如何调用API。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，需具备如下身份策略权限。

    授权项

    访问级别

    资源类型（*为必须）

    条件键

    别名

    依赖的授权项

    nat:natGateways:list

    List

    gateway *

    g:EnterpriseProjectId

    -

    -

URI

GET /v2/{project_id}/nat_gateways

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目的ID。

表2 Query参数

参数

是否必选

参数类型

描述

tenant_id

否

String

项目的ID。

id

否

String

公网NAT网关实例的ID。

enterprise_project_id

否

String

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

description

否

String

公网NAT网关实例的描述，长度范围小于等于255个字符，不能包含“<”和“>”。

created_at

否

String

公网NAT网关实例的创建时间，遵循UTC时间，格式是yyyy-mm-ddThh:mm:ssZ。

name

否

String

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

公网NAT网关实例的名字仅支持数字、字母、_（下划线）、-（中划线）、中文

status

否

Array of strings

公网NAT网关实例的状态。

取值为:

  • ACTIVE: 可用

  • PENDING_CREATE: 创建中

  • PENDING_UPDATE: 更新中

  • PENDING_DELETE: 删除中

  • INACTIVE: 不可用

spec

否

Array of strings

公网NAT网关实例的规格。

取值为：

  • 1：小型，SNAT最大连接数10000

  • 2：中型，SNAT最大连接数50000

  • 3：大型，SNAT最大连接数200000

  • 4：超大型，SNAT最大连接数1000000

  • 5：企业型，SNAT最大连接数10000000

admin_state_up

否

Boolean

解冻/冻结状态。

取值范围：

  • true：解冻

  • false：冻结

internal_network_id

否

String

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

router_id

否

String

VPC的id。

limit

否

Integer

功能说明：每页返回的个数。

取值范围：1~2000。

默认值：2000。

marker

否

String

分页查询的起始资源ID，表示从指定资源的下一条记录开始查询。

  • 若不传入marker和limit参数，查询结果返回第一页全部资源记录（默认2000条）。

  • 若不传入marker参数，limit为10，查询结果返回第1~10条资源记录。

  • 若marker为第10条记录的资源ID，limit为10，查询结果返回第11~20条资源记录。

  • 若marker为第10条记录的资源ID，不传入limit参数，查询结果返回第11条及之后的资源记录（默认2000条）。

sort_key

否

String

排序使用的key

sort_dir

否

String

返回结果按照升序或降序排列，默认降序desc，升序为asc

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

用户Token也就是调用获取用户Token获取请求认证接口的响应值，该接口是唯一不需要认证的接口。

请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

nat_gateways

Array of NatGatewayResponseBody objects

查询公网NAT网关实例列表的响应体。

详见NatGateway字段说明。

表5 NatGatewayResponseBody

参数

参数类型

描述

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

  • 5：企业型，SNAT最大连接数10000000

status

String

公网NAT网关实例的状态。

取值为:

  • ACTIVE: 可用

  • PENDING_CREATE: 创建中

  • PENDING_UPDATE: 更新中

  • PENDING_DELETE: 删除中

  • INACTIVE: 不可用

admin_state_up

Boolean

解冻/冻结状态。

取值范围：

  • true：解冻

  • false：冻结

created_at

String

公网NAT网关实例的创建时间，遵循UTC时间，格式是yyyy-mm-ddThh:mm:ssZ。

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网关会话参数配置。

ngport_ip_address

String

公网NAT网关私有IP地址，由VPC中子网分配。

billing_info

String

订单信息。此字段只有在订购包周期资源时才会有订单信息，而在订购按需资源时则为空。

dnat_rules_limit

Long

公网NAT网关下DNAT规则数量限制，默认为200。

snat_rule_public_ip_limit

Integer

公网NAT网关下SNAT规则EIP池中EIP数量限制，默认为20。

pps_max

Integer

网关每秒能够接收或发送的数据包数量，代表网络设备的流量处理能力。

bps_max

Integer

网关每秒能够接收或发送的带宽大小，代表网络设备的流量处理能力。单位M

表6 SessionConfiguration

参数

参数类型

描述

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状态持续时间（单位秒）。

请求示例

GET https://{NAT_endpoint}/v2/27e25061336f4af590faeabeb7fcd9a3/nat_gateways?status=ACTIVE

响应示例

状态码：200

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

{
  "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",
    "billing_info" : null,
    "dnat_rules_limit" : 200,
    "snat_rule_public_ip_limit" : 20,
    "ngport_ip_address" : "192.168.0.138",
    "session_conf" : {
      "tcp_session_expire_time" : 900,
      "udp_session_expire_time" : 300,
      "icmp_session_expire_time" : 10,
      "tcp_time_wait_time" : 5
    }
  }, {
    "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",
    "billing_info" : null,
    "dnat_rules_limit" : 200,
    "snat_rule_public_ip_limit" : 20,
    "ngport_ip_address" : "192.168.5.210",
    "session_conf" : {
      "tcp_session_expire_time" : 900,
      "udp_session_expire_time" : 300,
      "icmp_session_expire_time" : 10,
      "tcp_time_wait_time" : 5
    }
  } ]
}

状态码

状态码

描述

200

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

错误码

请参见错误码。

父主题：公网NAT网关