文档首页/ 云专线 DC/ API参考 (联盟区域) / API/ 专线关联连接/ 查询专线关联连接列表
更新时间：2026-01-08 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询专线关联连接列表

功能介绍

查询全域接入网关与ER等对象的关联连接列表，分页查询使用的参数为marker、limit。marker和limit一起使用时才会生效，单独使用无效

调用方法

请参见如何调用API。

URI

GET /v3/{project_id}/dcaas/global-dc-gateways/{global_dc_gateway_id}/peer-links

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

租户项目ID

最小长度：0

最大长度：36

global_dc_gateway_id

是

String

全域接入网关ID
表2 Query参数

参数

是否必选

参数类型

描述

limit

否

Integer

每页返回的个数。

取值范围：1~2000。

最小值：1

最大值：2000

缺省值：2000

offset

否

Integer

分页偏移量

最小值：1

最大值：1000

marker

否

String

上一页最后一条资源记录的ID，为空时为查询第一页。

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

最小长度：0

最大长度：36

page_reverse

否

Boolean

分页参数

fields

否

Array of strings

显示字段列表

数组长度：1 - 5

ext_fields

否

Array of strings

show response ext-fields

数组长度：0 - 5

sort_key

否

String

排序字段。

缺省值：id

最小长度：0

最大长度：36

sort_dir

否

Array of strings

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

id

否

Array of strings

根据资源ID过滤实例

数组长度：1 - 5

name

否

Array of strings

根据名称过滤查询，可查询多个名称。

数组长度：1 - 5

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

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

最小长度：0

最大长度：10240

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

peer_links

Array of PeerLinkEntry objects

专线关联连接列表。

数组长度：0 - 2000

page_info

PageInfo object

分页查询页的信息

request_id

String

请求ID。

最小长度：0

最大长度：36
表5 PeerLinkEntry

参数

参数类型

描述

id

String

peer link ID。

最小长度：0

最大长度：36

tenant_id

String

租户项目ID

最小长度：0

最大长度：255

name

String

专线内部连接(peer link)名称

最小长度：0

最大长度：64

description

String

描述信息

最小长度：0

最大长度：255

reason

String

失败原因

最小长度：0

最大长度：255

global_dc_gateway_id

String

对应的专线全域接入网关ID

最小长度：0

最大长度：64

bandwidth_info

BandWidthInfo object

带宽信息

peer_site

PeerSite object

对端的网关的描述信息

status

String

关联连接状态。取值范围：

  • PENDING_CREATE：创建中

  • PENDING_UPDATE：更新中

  • ACTIVE：可用

  • ERROR：失败

created_time

String

创建时间。

updated_time

String

更新时间。

create_owner

String

创建归属服务名。取值范围：

  • cc：云连接

  • dc：云专线

instance_id

String

实例ID
表6 BandWidthInfo

参数

参数类型

描述

bandwidth_size

Integer

带宽值

最小值：0

最大值：268435455

gcb_id

String

购买全域互连带宽包ID

最小长度：0

最大长度：36
表7 PeerSite

参数

参数类型

描述

gateway_id

String

对端网关的ID

最小长度：0

最大长度：36

link_id

String

对端网关连接的ID(如：对端为ER时为attachment ID,对端为GDGW时为对端的PeerLink Id

最小长度：0

最大长度：64

region_id

String

对端网关所在的Region

最小长度：0

最大长度：36

site_code

String

专线全域接入网关对应的站点位置

最小长度：0

最大长度：64

project_id

String

对等体站点的项目ID

最小长度：0

最大长度：36

type

String

对等体的类型

  • ER 企业路由器

  • GDGW 全域接入网关

最小长度：0

最大长度：64
表8 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/b197c48159d44a66b32c538c3f8da89a/dcaas/global-dc-gateways/1c6edc27-5fdb-4dae-ac77-72d47c70ed83/peer-links

响应示例

状态码：200

OK

专线连接查询列表结果

{
  "request_id" : "d6f35fa3bde2e26efad6253bd32b4837",
  "peer_links" : [ {
    "name" : "dgw-zss-02_1_peer_link",
    "id" : "5ad07c58-71a8-41b7-a5c0-5b6148d518b2",
    "tenant_id" : "b197c48159d44a66b32c538c3f8da89a",
    "description" : "",
    "reason" : null,
    "status" : "ACTIVE",
    "created_time" : "2024-06-21T01:48:57.000Z",
    "updated_time" : "2024-11-17T08:44:18.504Z",
    "global_dc_gateway_id" : "1c6edc27-5fdb-4dae-ac77-72d47c70ed83",
    "bandwidth_info" : {
      "bandwidth_size" : 0,
      "gcb_id" : null
    },
    "peer_site" : {
      "gateway_id" : "f8551651-0f42-48ff-9088-fff87e6d74e2",
      "link_id" : "c794a0f3-e89d-4e64-a614-9b6be4394b07",
      "region_id" : "cn-southwest-246",
      "site_code" : "cn-southwest-246",
      "project_id" : "6bea6e6ed6b34892bd2e195cad496348",
      "type" : "ER"
    },
    "create_owner" : "cc",
    "instance_id" : "f174fa3e-d63a-45bb-a5a4-b56782552494"
  } ]
}

状态码

状态码

描述

200

OK

错误码

请参见错误码。

父主题： 专线关联连接