文档首页/ 企业路由器 ER/ API参考（安卡拉区域）/ API/ VPC连接/ 查询VPC连接列表
更新时间：2024-12-27 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询VPC连接列表

功能介绍

查询企业路由器实例下的VPC连接列表。

接口约束

  • 支持过滤查询，过滤条件有id，state，enterprise_project_id，vpc_id，过滤条件可以重复和组合。

  • 支持分页查询，limit和marker组合实现分页查询。

  • 支持单字段排序功能，排序字段有[id,name,description,created_at,updated_at]，不支持多字段排序。

调用方法

请参见如何调用API。

URI

GET /v3/{project_id}/enterprise-router/{er_id}/vpc-attachments

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID

er_id

是

String

企业路由器实例ID
表2 Query参数

参数

是否必选

参数类型

描述

limit

否

Integer

每页返回的个数。

取值范围：0~2000。

最小值：0

最大值：2000

marker

否

String

查询的页码id，为空时为查询第一页。

使用说明：必须与limit一起使用。

最小长度：1

最大长度：128

state

否

Array of strings

连接状态:pending|available|modifying|deleting|deleted|failed|pending_acceptance|rejected|initiating_request

id

否

Array of strings

根据资源ID查询，可同时查询多个。

sort_key

否

Array of strings

按关键字排序，默认按照id排序，可选值:id|name|state

sort_dir

否

Array of strings

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

vpc_id

否

Array of strings

VPC id

请求参数

无

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

vpc_attachments

Array of VpcAttachmentDetails objects

VPC连接列表

page_info

PageInfo object

分页查询的信息

request_id

String

请求ID
表4 VpcAttachmentDetails

参数

参数类型

描述

id

String

VPC连接ID

name

String

VPC连接名称

vpc_id

String

VPC id

virsubnet_id

String

VPC子网id

auto_create_vpc_routes

Boolean

默认为false,当设置true时，会自动为VPC配置10.0.0.0/8, 172.16.0.0/12, 192.168.0.0/16三条路由，下一跳指向企业路由器。

缺省值：false

state

String

VPC连接状态:pending|available|modifying|deleting|deleted|failed|initiating_request|rejected|pending_acceptance|freezed|invalid

created_at

String

创建时间,格式:YYYY-MM-DDTHH:mm:ss.sssZ

updated_at

String

更新时间,格式:YYYY-MM-DDTHH:mm:ss.sssZ

tags

Array of Tag objects

标签信息

description

String

VPC连接描述信息

project_id

String

项目ID

vpc_project_id

String

vpc所属项目ID

route_synchronization

RouteSynchronization object

路由同步配置
表5 Tag

参数

参数类型

描述

key

String

标签键，规则：

  • 可用 UTF-8 格式表示的字母(包含中文)、数字和空格，以及字符：下划线“_”，点“.”，冒号“:”，等号“=”，加号“+”，中划线“-”，“@”。

  • _sys_开头属于系统标签，租户不能输入。

  • 标签key不能为空（长度不能为0）。

  • 长度在1-128之间。

最小长度：1

最大长度：128

value

String

标签值，规则：

  • 可用 UTF-8 格式表示的字母(包含中文)、数字和空格，以及字符：下划线“_”，点“.”，冒号“:”，等号“=”，加号“+”，中划线“-”，“@”。

  • 资源标签值可以为空（empty or null）。

  • 长度在0-255之间。

最小长度：0

最大长度：255
表6 RouteSynchronization

参数

参数类型

描述

route_synchronization_enable

Boolean

路由同步开关

vpc_route_table_type

String

需要同步的VPC路由表

route_type

String

需要同步的路由类型

conflict_policy

String

冲突策略 目标地址相同并指向当前实例的路由执行的发布策略
表7 PageInfo

参数

参数类型

描述

next_marker

String

下一个marker标识，为空时表示最后一页

current_count

Integer

当前列表中资源数量

请求示例

  • 分页查询VPC连接信息

    GET https://{erouter_endpoint}/v3/08d5a9564a704afda6039ae2babbef3c/enterprise-router/vpc-attachments?limit=10

  • 查询全量VPC连接信息

    GET https://{erouter_endpoint}/v3/08d5a9564a704afda6039ae2babbef3c/enterprise-router/vpc-attachments

响应示例

状态码： 200

OK

{
  "vpc_attachments" : [ {
    "id" : "6f83b848-8331-4271-ac0c-ef94b7686402",
    "name" : "vpc-attach-01",
    "vpc_id" : "b715e131-3371-4e17-a2de-4f669e24439a",
    "virsubnet_id" : "aacdc21d-90f9-45ef-ab48-80ec1bbe15b8",
    "project_id" : "08d5a9564a704afda6039ae2babbef3c",
    "state" : "available",
    "created_at" : "2020-03-11T15:13:31Z",
    "updated_at" : "2020-03-11T15:13:31Z"
  }, {
    "id" : "6f83b848-8331-4271-ac0c-ef94b7686402",
    "name" : "vpc-attach-01",
    "vpc_id" : "4b8567f6-358f-4a7f-8cd3-3cbb82c0b25f",
    "virsubnet_id" : "2b55f334-a15e-43a9-ab11-b34c2dbb6fac",
    "project_id" : "08d5a9564a704afda6039ae2babbef3c",
    "state" : "available",
    "created_at" : "2020-03-11T15:13:31Z",
    "updated_at" : "2020-03-11T15:13:31Z"
  } ],
  "page_info" : {
    "next_marker" : "1",
    "current_count" : 2
  },
  "request_id" : "915a14a6-867b-4af7-83d1-70efceb146f9"
}

状态码

状态码

描述

200

OK

错误码

请参见错误码。

父主题： VPC连接