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

查询连接列表

功能介绍

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

接口约束

  • 支持过滤查询，过滤条件有state，resource_type，resource_id过滤条件可以重复和组合；

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

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

调用方法

请参见如何调用API。

URI

GET /v3/{project_id}/enterprise-router/{er_id}/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

resource_type

否

Array of strings

  • vpc：虚拟私有云

  • vpn：vpn网关

  • vgw：云专线的虚拟网关

  • gdgw：下一代专线网关

resource_id

否

Array of strings

连接对应的资源ID列表

sort_key

否

Array of strings

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

sort_dir

否

Array of strings

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

请求参数

无

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

attachments

Array of AttachmentDetails objects

连接列表

page_info

PageInfo object

分页查询的信息

request_id

String

请求ID

表4 AttachmentDetails

参数

参数类型

描述

id

String

连接ID

name

String

连接名字

description

String

描述信息

state

String

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

created_at

String

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

updated_at

String

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

tags

Array of Tag objects

企业路由器关联tag

project_id

String

项目ID

er_id

String

Enterprise router ID

resource_id

String

内部连接关联的资源ID

resource_type

String

内部连接关联的资源类型:

  • vgw：云专线的虚拟网关

  • vpn：vpn网关

  • gdgw：下一代专线网关

  • vpc：虚拟私有云

resource_project_id

String

资源所属项目ID

associated

Boolean

表示此连接是否被关联

route_table_id

String

关联路由表id

表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 PageInfo

参数

参数类型

描述

next_marker

String

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

current_count

Integer

当前列表中资源数量

请求示例

查询连接列表

GET https://{erouter_endpoint}/v3/08d5a9564a704afda6039ae2babbef3c/enterprise-router/4ab54142-7c92-48ad-8288-77727a231052/attachments

响应示例

状态码： 200

OK

{
  "attachments" : [ {
    "id" : "6f83b848-8331-4271-ac0c-ef94b7686402",
    "name" : "vpc-001",
    "description" : "vpc attachment",
    "resource_id" : "b715e131-3371-4e17-a2de-4f669e24439a",
    "resource_type" : "vpc",
    "project_id" : "0605767a9980d5762fbcc00b3537e757",
    "state" : "available",
    "created_at" : "2020-03-11T15:13:31Z",
    "updated_at" : "2020-03-11T15:13:31Z"
  }, {
    "id" : "6f83b848-8331-4271-ac0c-ef94b7686403",
    "name" : "vpc-002",
    "description" : "for test",
    "resource_id" : "4b8567f6-358f-4a7f-8cd3-3cbb82c0b25f",
    "resource_type" : "vpc",
    "project_id" : "0605767a9980d5762fbcc00b3537e757",
    "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" : "b715e131-3371-4e17-a2de-4f669e24439a"
}

状态码

状态码

描述

200

OK

错误码

请参见错误码。

父主题：其他连接