文档首页/事件网格 EG/API参考/API/目标连接管理/查询目标连接列表 - ListConnections
更新时间：2025-12-18 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询目标连接列表 - ListConnections

功能介绍

查询目标连接列表。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见权限和授权项。

URI

GET /v1/{project_id}/connections

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

租户资源空间ID

表2 Query参数

参数

是否必选

参数类型

描述

offset

否

Integer

偏移量，表示从此偏移量开始查询，偏移量不能小于0

limit

否

Integer

每页显示的条目数量，不能小于1或大于1000

sort

否

String

指定查询排序

name

否

String

指定查询的目标连接名称，精准匹配

fuzzy_name

否

String

指定查询的目标连接名称，模糊匹配

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

total

Integer

总数

size

Integer

本页数量

items

Array of ConnectionInfo objects

对象列表

表5 ConnectionInfo

参数

参数类型

描述

id

String

事件源ID

name

String

目标连接名称，租户下唯一，由小写字母、数字、点、下划线和中划线组成，必须以字母或数字开头，不能为default

description

String

目标连接描述

status

String

目标连接状态：

  • CREATING：创建中

  • CREATED：已创建

  • CREATE_FAILED：创建失败

error_info

ErrorInfo object

错误信息

vpc_id

String

待连接的VPC ID

subnet_id

String

待连接的子网ID

agency

String

私网目标连接使用的用户委托名称

flavor

flavor object

规格

type

String

目标连接类型，参数如下：

WEBHOOK：自定义http/https连接；

KAFKA：DMS服务Kafka实例；

ROCKETMQ：DMS服务RocketMQ实例。

kafka_detail

KafkaConnectionDetail object

kafka连接参数

created_time

String

创建UTC时间

updated_time

String

更新UTC时间

rocketmq_detail

RocketmqConnectionDetail object

RocketMQ目标端连接的参数

表6 ErrorInfo

参数

参数类型

描述

error_code

String

错误码

error_detail

String

错误详情

error_msg

String

错误信息

表7 flavor

参数

参数类型

描述

name

String

规格名称

concurrency_type

String

并发规格类型：

  • shared：共享

  • exclusive：专享

concurrency

Integer

并发数

bandwidth_type

String

带宽类型：

  • shared：共享

  • exclusive：专享

表8 KafkaConnectionDetail

参数

参数类型

描述

instance_id

String

kafka实例id。

addr

String

kafka连接地址。

security_protocol

String

安全协议。

enable_sasl_ssl

Boolean

kafka实例是否开启了SASL_SSL。

user_name

String

kafka实例用户名。实例开启了SASL_SSL时必填

password

String

kafka实例密码。实例开启了SASL_SSL时必填

acks

String

收到Server端确认信号个数，表示producer需要收到多少个这样的确认信号，算消息发送成功。acks参数代表了数据备份的可用性。支持选项：

acks=0：表示producer不需要等待任何确认收到的信息，副本将立即加到socket buffer并认为已经发送。没有任何保障可以保证此种情况下server已经成功接收数据，同时重试配置不会发生作用（因为客户端不知道是否失败）回馈的offset会总是设置为-1。

acks=1：这意味着至少要等待leader已经成功将数据写入本地log，但是并没有等待所有follower是否成功写入。如果follower没有成功备份数据，而此时leader又无法提供服务，则消息会丢失。

acks=all：这意味着leader需要等待ISR中所有备份都成功写入日志，只有任何一个备份存活，数据都不会丢失。min.insync.replicas指定必须确认写入才能被认为成功的副本的最小数量。

表9 RocketmqConnectionDetail

参数

参数类型

描述

instance_id

String

实例ID

addr

String

连接地址

use_tls

Boolean

是否开启SSL

enable_acl

String

是否启用ACL访问控制

user_name

String

用户名，仅在开启ACL访问控制时需要配置

password

String

密码，仅在开启ACL访问控制时需要配置

请求示例

查询目标连接列表

GET https://{endpoint}/v1/{project_id}/connections

响应示例

状态码：200

列表

{
  "total" : 1,
  "size" : 1,
  "items" : [ { } ]
}

状态码

状态码

描述

200

列表

错误码

请参见错误码。

父主题：目标连接管理