文档首页/ NAT网关 NAT/ API参考（吉隆坡区域）/ API v2/ NAT网关/ 查询NAT网关列表
更新时间：2022-08-08 GMT+08:00
查看PDF
分享

查询NAT网关列表

功能介绍

查询NAT网关列表。如无特殊说明，匹配规则为精确匹配。

URI

GET /v2/{project_id}/nat_gateways

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

表1 参数说明

参数

是否必选

参数类型

描述

project_id

是

String

项目ID。

limit

否

Integer

每页返回的个数。

id

否

String

NAT网关的id。

tenant_id

否

String

项目ID。

name

否

String(64)

NAT网关的名字。

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

description

否

String(255)

NAT网关的描述。

spec

否

String

NAT网关的规格。

取值为：

  • “1”：小型，SNAT最大连接数10000
  • “2”：中型，SNAT最大连接数50000
  • “3”：大型，SNAT最大连接数200000
  • “4”：超大型，SNAT最大连接数1000000

router_id

否

String

路由器的UUID。

internal_network_id

否

String

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

status

否

String

admin_state_up

否

Boolean
  • 解冻/冻结状态。
  • 取值范围：
    • “true”：解冻
    • “false”：冻结

created_at

否

String
  • NAT网关的创建时间戳，遵循UTC时间，保留小数点后6位，格式是yyyy-mm-dd hh:mm:ss

enterprise_project_id

否

String
  • 功能说明：企业项目ID。默认值：0，表示默认企业项目。
  • 取值范围：最大长度36字节，带 “-”连字符的UUID格式，或者是字符串“0”。

请求消息

无

响应消息

响应参数如表2所示。

表2 响应参数

参数

参数类型

描述

nat_gateways

Array(Object)

nat_gateway对象列表。请参考表3。
表3 nat_gateway字段说明

参数

参数类型

描述

id

String

NAT网关的id。

tenant_id

String

项目ID。

name

String(64)

NAT网关的名字。

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

description

String(255)

NAT网关的描述。

spec

String

NAT网关的规格。

取值为：

  • “1”：小型，SNAT最大连接数10000
  • “2”：中型，SNAT最大连接数50000
  • “3”：大型，SNAT最大连接数200000
  • “4”：超大型，SNAT最大连接数1000000

router_id

String

路由器的UUID。

internal_network_id

String

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

status

String

admin_state_up

Boolean
  • 解冻/冻结状态。
  • 取值范围：
    • “true”：解冻
    • “false”：冻结

created_at

String

创建时间戳，遵循UTC时间，保留小数点后6位，格式是yyyy-mm-dd hh:mm:ss

dnat_rules_limit

String

NAT网关的DNAT规则最多条数限制值

snat_rule_public_ip_limit

String

NAT网关的任意一条SNAT规则最多绑定的弹性公网IP的数量最大限制值。

billing_info

String

包周期NAT网关订单关联信息，按需值为空字符串。

enterprise_project_id

String
  • 功能说明：企业项目ID。默认值：0，表示默认企业项目。
  • 取值范围：最大长度36字节，带 “-”连字符的UUID格式，或者是字符串“0”。

示例

  • 请求样例 
    GET https://{Endpoint}/v2/d199ba7e0ba64899b2e81518104b1526/nat_gateways?status=ACTIVE
  • 响应样例 
    { 
    "nat_gateways": [ 
        { 
            "router_id": "b1d81744-5165-48b8-916e-e56626feb88f", 
            "status": "ACTIVE", 
            "description": "", 
            "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", 
            "id": "a253be25-ae7c-4013-978b-3c0785eccd63", 
            "name": "wj3",
            "dnat_rules_limit": "200",
            "snat_rule_public_ip_limit": "20",
            "enterprise_project_id": 0aad99bc-f5f6-4f78-8404-c598d76b0ed2", 
            "billing_info": ""

        }, 
        { 
            "router_id": "305dc52f-13dd-429b-a2d4-444a1039ba0b", 
            "status": "ACTIVE", 
            "description": "", 
            "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", 
            "id": "e824f1b4-4290-4ebc-8322-cfff370dbd1e", 
            "name": "lyl001",
            "dnat_rules_limit": "200",
            "snat_rule_public_ip_limit": "20",
            "enterprise_project_id": 0aad99bc-f5f6-4f78-8404-c598d76b0ed2", 
            "billing_info": ""
        } 
    ] 
}

状态码

请参考状态码。

父主题： NAT网关