文档首页/ NAT网关 NAT/ API参考 (巴黎区域) / API（私网NAT网关）/ 私网NAT网关/ 查询私网NAT网关列表
更新时间：2024-03-30 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询私网NAT网关列表

功能介绍

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

接口约束

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

调用方法

请参见如何调用API。

URI

GET /v3/{project_id}/private-nat/gateways

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目的ID。

最小长度：1

最大长度：36
表2 Query参数

参数

是否必选

参数类型

描述

limit

否

Integer

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

最小值：1

最大值：2000

缺省值：2000

marker

否

String

功能说明：分页查询起始的资源ID，为空时查询第一页。 值从上一次查询的PageInfo中的next_marker或者previous_marker中获取。

最小长度：36

最大长度：36

page_reverse

否

Boolean

是否查询前一页。

id

否

Array

私网NAT网关实例的ID。

数组长度：1 - 10

name

否

Array

私网NAT网关实例的名字。

数组长度：1 - 10

description

否

Array

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

数组长度：1 - 10

spec

否

Array

私网NAT网关实例的规格。 取值为： "Small"：小型 "Medium"：中型 "Large"：大型 "Extra-large"：超大型

数组长度：1 - 10

枚举值：

  • Small

  • Medium

  • Large

  • Extra-large

project_id

否

Array

项目的ID。

数组长度：1 - 10

status

否

Array

私网NAT网关实例的状态。 取值为： "ACTIVE"：正常运行 "FROZEN"：冻结

数组长度：1 - 10

枚举值：

  • ACTIVE

  • FROZEN

vpc_id

否

Array

私网NAT网关实例所属VPC的ID。

数组长度：1 - 10

virsubnet_id

否

Array

私网NAT网关实例所属子网的ID。

数组长度：1 - 10

enterprise_project_id

否

Array

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

数组长度：1 - 10

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

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

最小长度：1

最大长度：10240

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

gateways

Array of PrivateNat objects

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

数组长度：0 - 2000

request_id

String

请求ID。

最小长度：1

最大长度：36

page_info

PageInfo object

分页信息。
表5 PrivateNat

参数

参数类型

描述

id

String

私网NAT网关实例的ID。

最小长度：36

最大长度：36

project_id

String

项目的ID。

最小长度：32

最大长度：32

name

String

私网NAT网关实例的名字。

最小长度：1

最大长度：64

description

String

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

最小长度：0

最大长度：255

spec

String

私网NAT网关实例的规格。 取值为： "Small"：小型 "Medium"：中型 "Large"：大型 "Extra-large"：超大型

缺省值：Small

枚举值：

  • Small

  • Medium

  • Large

  • Extra-large

status

String

私网NAT网关实例的状态。 取值为： "ACTIVE"：正常运行 "FROZEN"：冻结

枚举值：

  • ACTIVE

  • FROZEN

created_at

String

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

updated_at

String

私网NAT网关实例的更新时间，遵循UTC时间，格式是yyyy-mm-ddThh:mm:ssZ。

downlink_vpcs

Array of DownlinkVpc objects

私网NAT网关实例所属的VPC实例。

数组长度：1 - 10

tags

Array of Tag objects

标签列表。

数组长度：1 - 10

enterprise_project_id

String

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

最小长度：1

最大长度：36
表6 DownlinkVpc

参数

参数类型

描述

vpc_id

String

私网NAT网关实例所属VPC的ID。

最小长度：36

最大长度：36

virsubnet_id

String

私网NAT网关实例所属子网的ID。

最小长度：36

最大长度：36
表7 Tag

参数

参数类型

描述

key

String

标签key值。

最小长度：1

最大长度：128

value

String

标签value。

最小长度：0

最大长度：255
表8 PageInfo

参数

参数类型

描述

next_marker

String

分页查询结果中最后一条记录的ID。通常用于查询下一页。

最小长度：1

最大长度：36

previous_marker

String

分页查询结果中第一条记录的ID。通常用于配合page_reverse=true查询上一页。

最小长度：1

最大长度：36

current_count

Integer

分页查询资源时，本页的实例的个数。

最小值：1

最大值：2000

请求示例

GET https://{Endpoint}/v3/70505c941b9b4dfd82fd351932328a2f/private-nat/gateways

响应示例

状态码： 200

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

{
  "gateways" : [ {
    "id" : "14338426-6afe-4019-996b-3a9525296e11",
    "name" : "private-nat-gateway-name1",
    "description" : "private-nat-gateway-description1",
    "spec" : "Small",
    "project_id" : "70505c941b9b4dfd82fd351932328a2f",
    "enterprise_project_id" : "2759da7b-8015-404c-ae0a-a389007b0e2a",
    "status" : "ACTIVE",
    "created_at" : "2019-04-22T08:47:13",
    "updated_at" : "2019-04-22T08:47:13",
    "tags" : [ {
      "key" : "key1",
      "value" : "value1"
    } ],
    "downlink_vpcs" : [ {
      "vpc_id" : "3cb66d44-9f75-4237-bfff-e37b14d23ad2",
      "virsubnet_id" : "373979ee-f4f0-46c5-80e3-0fbf72646b70"
    } ]
  }, {
    "id" : "65995b8e-dcb7-4ab4-9931-bc3c95beec0a",
    "name" : "private-nat-gateway-name2",
    "description" : "private-nat-gateway-description2",
    "spec" : "Small",
    "project_id" : "70505c941b9b4dfd82fd351932328a2f",
    "enterprise_project_id" : "2759da7b-8015-404c-ae0a-a389007b0e2a",
    "status" : "ACTIVE",
    "created_at" : "2019-04-22T09:06:54",
    "updated_at" : "2019-04-22T09:06:54",
    "tags" : [ {
      "key" : "key1",
      "value" : "value1"
    } ],
    "downlink_vpcs" : [ {
      "vpc_id" : "3cb66d44-9f75-4237-bfff-e37b14d23ad2",
      "virsubnet_id" : "373979ee-f4f0-46c5-80e3-0fbf72646b70"
    } ]
  } ],
  "request_id" : "a7b00469-5a31-4274-bb10-59167243383e",
  "page_info" : {
    "previous_marker" : "14338426-6afe-4019-996b-3a9525296e11",
    "current_count" : 2
  }
}

状态码

状态码

描述

200

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

错误码

请参见错误码。

父主题： 私网NAT网关