更新时间:2024-11-21 GMT+08:00
分享

获取连接器列表

功能介绍

本接口用于获取连接器信息。

调用方法

请参见如何调用API

URI

GET /v1/agents/connectors

表1 Query参数

参数

是否必选

参数类型

描述

offset

Integer

起始位置。

当前页面数,默认为0,取值0-2147483647。

取值为0时系统默认返回第1页,与取值为1相同。

limit

Integer

查询个数。

查询返回连接器的个数,每页默认值是10,取值0-100,每页最多返回100个。

connector_query_type

String

连接器类型,主要分为多方安全计算连接器和可信联邦学习连接器。

多方安全计算连接器

MRS,

RDS_MYSQL,

DWS,

JDBC,

MYSQL,

ORACLE,

可信联邦学习连接器

LOCAL

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

通过调用接口获取用户Token接口获取。

X-Language

String

根据自己偏好的语言来获取不同语言的返回内容,zh-cn或者en_us

Content-Type

String

消息体的类型(格式),必选,默认取值为“application/json”,有其他取值时会在具体接口中专门说明。

响应参数

状态码: 200

表3 响应Body参数

参数

参数类型

描述

total

Long

总个数

lists

Array of ConnectorListVo objects

连接器列表

表4 ConnectorListVo

参数

参数类型

描述

id

String

连接器id

name

String

连接器名称

connector_type

String

连接器类型

create_time

String

创建时间

ext_info

String

json格式存放键值对形式配置信息

connector_status

String

连接器状态

1.NORMAL----正常

2.ABNORMAL----异常

3.STARTING----启动中

请求示例

获取连接器列表

get https://x.x.x.x:12345/v1/agents/connectors?offset=0&limit=10

响应示例

状态码: 200

获取连接器列表成功

{
  "total" : 1,
  "lists" : [ {
    "id" : "40f9608dd30b485dbb9d8ebe8cd13b7c",
    "name" : "localConnector",
    "status" : "NORMAL",
    "connector_type" : "LOCAL",
    "create_time" : "2022-04-06T10:25:00.281+00:00",
    "connector_status" : "NORMAL"
  } ]
}

状态码

状态码

描述

200

获取连接器列表成功

401

操作无权限

500

内部服务器错误

相关文档