文档首页/云专线 DC/API参考 (巴黎区域) /API/虚拟网关/查询虚拟网关列表
更新时间：2024-07-25 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询虚拟网关列表

功能介绍

查询虚拟网关列表

调用方法

请参见如何调用API。

URI

GET /v3/{project_id}/dcaas/virtual-gateways

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

租户项目ID

表2 Query参数

参数

是否必选

参数类型

描述

limit

否

Integer

每页返回的个数。 取值范围：1~2000。

最小值：1

最大值：2000

缺省值：2000

marker

否

String

上一页最后一条资源记录的ID，为空时为查询第一页。 使用说明：必须与limit一起使用。

最小长度：0

最大长度：36

fields

否

Array

显示字段列表

数组长度：1 - 5

sort_dir

否

Array

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

sort_key

否

String

排序字段。

缺省值：id

最小长度：0

最大长度：36

id

否

Array

根据资源ID过滤实例

数组长度：1 - 5

enterprise_project_id

否

Array

根据企业项目ID过滤资源实例

数组长度：1 - 10

vpc_id

否

Array

通过VPC-ID过滤虚拟网关实例

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。 获取Token，请参考《统一身份认证服务API参考》的“获取用户Token”章节。请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。

最小长度：0

最大长度：10240

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

request_id

String

操作请求ID

virtual_gateways

Array of VirtualGateway objects

虚拟网关对象列表

page_info

PageInfo object

分页查询页的信息

表5 VirtualGateway

参数

参数类型

描述

id

String

虚拟网关的ID

vpc_id

String

虚拟网关接入的VPC的ID

tenant_id

String

实例所属项目ID。

最小长度：32

最大长度：32

name

String

虚拟网关的名字

最小长度：0

最大长度：64

description

String

虚拟网关的描述

最小长度：0

最大长度：128

type

String

虚拟网关类型：default

缺省值：default

local_ep_group

Array of strings

虚拟网关到访问云上服务IPv4子网列表，通常是vpc的cidrs

local_ep_group_ipv6

Array of strings

预留字段用于虚拟网关到访问云上服务IPv6子网列表，通常是vpc的cidrs

admin_state_up

Boolean

管理状态：true或false

缺省值：true

status

String

操作状态，合法值是：ACTIVE，DOWN，BUILD，ERROR，PENDING_CREATE，PENDING_UPDATE，PENDING_DELETE

bgp_asn

Integer

虚拟网关本地的BGP自冶域号(asn)

最小值：1

最大值：4294967295

enterprise_project_id

String

实例所属企业项目ID

最小长度：36

最大长度：36

device_id

String

归属的设备ID

redundant_device_id

String

归属的冗余设备ID

public_border_group

String

归属的可用区对应的边界组(public border group)，标识是否homezone局点。

表6 PageInfo

参数

参数类型

描述

previous_marker

String

上一页的marker，值为资源的uuid

最小长度：0

最大长度：36

current_count

Integer

当前列表中资源数量

最小值：0

最大值：2000

next_marker

String

下一页的marker，值为资源的uuid，为空时表示最后一页

最小长度：0

最大长度：36

请求示例

查询虚拟网关列表

GET https://{dc_endpoint}/v3/0605768a3300d5762f82c01180692873/dcaas/virtual-gateways

响应示例

状态码： 200

OK

  • 成功查询接入虚拟私有云的虚拟网关列表。 
    {
  "virtual_gateways" : [ {
    "id" : "20082c1b-3c99-48d8-8e8c-116af5d7e9f0",
    "name" : "vgw-c7b22",
    "description" : "",
    "tenant_id" : "0605768a3300d5762f82c01180692873",
    "vpc_id" : "6592c28e-95d7-4b0a-9f61-004fdf03420c",
    "device_id" : "26.151.63.100",
    "redundant_device_id" : "26.152.128.20",
    "type" : "default",
    "status" : "ACTIVE",
    "admin_state_up" : true,
    "bgp_asn" : 64512,
    "local_ep_group" : [ "192.168.1.0/24" ],
    "enterprise_project_id" : "0",
    "public_border_group" : "center"
  } ],
  "request_id" : "765f7aaf8f2edd0e719de564ef72e2de"
}

状态码

状态码

描述

200

OK

错误码

请参见错误码。

父主题：虚拟网关