文档首页> NAT网关 NAT> API参考> API> 公网NAT网关> 查询公网NAT网关列表
更新时间：2022-03-28 GMT+08:00
查看PDF
分享

查询公网NAT网关列表

功能介绍

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

接口约束

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

调试

您可以在API Explorer中调试该接口。

URI

GET /v2/{project_id}/nat_gateways

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目的ID。

最小长度：1

最大长度：36

获取方法详见获取项目ID。
表2 Query参数

参数

是否必选

参数类型

描述

tenant_id

否

String

项目的ID。

获取方法详见获取项目ID。

id

否

String

公网NAT网关实例的ID。

最小长度：1

最大长度：36

enterprise_project_id

否

String

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

最大长度：36

description

否

String

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

最大长度：255

created_at

否

String

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

最小长度：1

最大长度：36

name

否

String

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

最小长度：1

最大长度：64

status

否

Array

公网NAT网关实例的状态。

枚举值：

  • ACTIVE
  • PENDING_CREATE
  • PENDING_UPDATE
  • PENDING_DELETE
  • INACTIVE

spec

否

Array

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

枚举值：

  • 1
  • 2
  • 3
  • 4

admin_state_up

否

Boolean

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

  • "true"：解冻
  • "false"：冻结

internal_network_id

否

String

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

长度：36

router_id

否

String

VPC的id。

长度：36

limit

否

Integer

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

最小值：0

最大值：2000

缺省值：2000

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

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

最小长度：1

最大长度：10240

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

nat_gateways

Array of NatGatewayResponseBody objects

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

参数

参数类型

描述

id

String

公网NAT网关实例的ID。

长度：36

tenant_id

String

项目的ID。

name

String

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

最小长度：1

最大长度：64

description

String

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

最大长度：255

spec

String

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

枚举值：

  • 1
  • 2
  • 3
  • 4

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。

最大长度：36

请求示例

GET https://{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"
  }, {
    "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"
  } ]
}

状态码

状态码

描述

200

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

错误码

请参见错误码。

父主题： 公网NAT网关
分享：

    相关文档

    相关产品

close