.jpg)
.jpg)
.jpg)
.jpg)
功能介绍
查询虚拟网关列表
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
URI
GET /v3/{project_id}/dcaas/virtual-gateways
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
租户项目ID |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
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过虑虚拟网关实例 |
请求参数
响应参数
状态码： 200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
request_id |
String |
操作请求ID |
|
virtual_gateways |
虚拟网关对象列表 |
|
|
page_info |
分页查询页的信息 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
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 |
|
tags |
标签信息 数组长度：0 - 10 |
请求示例
查询虚拟网关列表
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",
"type" : "default",
"status" : "ACTIVE",
"admin_state_up" : true,
"bgp_asn" : 64512,
"local_ep_group" : [ "192.168.1.0/24" ],
"enterprise_project_id" : "0"
} ],
"request_id" : "765f7aaf8f2edd0e719de564ef72e2de"
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
OK |
错误码
请参见错误码。
