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

查询指定的公网NAT网关详情 - ShowNatGateway

功能介绍

查询指定的公网NAT网关实例详情。

调用方法

请参见如何调用API。

授权信息

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

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

    授权项

    访问级别

    资源类型（*为必须）

    条件键

    别名

    依赖的授权项

    nat:natGateways:get

    Read

    gateway *

    • g:EnterpriseProjectId

    • g:ResourceTag/<tag-key>

    -

    -

URI

GET /v2/{project_id}/nat_gateways/{nat_gateway_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目的ID。

nat_gateway_id

是

String

公网NAT网关实例的ID。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

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

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

响应参数

状态码：200

表3 响应Body参数

参数

参数类型

描述

nat_gateway

NatGatewayResponseBody object

公网NAT网关实例的响应体。

表4 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

表5 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/70505c941b9b4dfd82fd351932328a2f/nat_gateways/14338426-6afe-4019-996b-3a9525296e11

响应示例

状态码：200

查询公网NAT网关实例成功。

{
  "nat_gateway" : {
    "id" : "14338426-6afe-4019-996b-3a9525296e11",
    "name" : "nat-gateway-name",
    "description" : "nat-gateway-description",
    "spec" : "1",
    "router_id" : "d84f345c-80a1-4fa2-a39c-d0d397c3f09a",
    "tenant_id" : "70505c941b9b4dfd82fd351932328a2f",
    "enterprise_project_id" : "2759da7b-8015-404c-ae0a-a389007b0e2a",
    "internal_network_id" : "89d66639-aacb-4929-969d-07080b0f9fd9",
    "status" : "ACTIVE",
    "admin_state_up" : true,
    "billing_info" : null,
    "dnat_rules_limit" : 200,
    "snat_rule_public_ip_limit" : 20,
    "ngport_ip_address" : "192.168.0.138",
    "created_at" : "2019-04-22 08:47:13.902312",
    "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网关