文档首页/ 数据治理中心 DataArts Studio/ 更多文档/ API参考 (联盟区域) / 数据集成API/ 连接管理/ 查询连接
更新时间：2026-01-30 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询连接

功能介绍

查询连接接口。

调用方法

请参见如何调用API。

URI

GET /v1.1/{project_id}/clusters/{cluster_id}/cdm/link/{link_name}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID，获取方法请参见项目ID和账号ID。

cluster_id

是

String

集群ID。

link_name

是

String

连接名称。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

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

响应参数

状态码：200

表3 响应Body参数

参数

参数类型

描述

links

Array of links objects

连接列表，请参见links数据结构说明。

fromTo-unMapping

String

表/文件迁移不支持哪些数据源迁移到哪些数据源。

batchFromTo-mapping

String

整库迁移支持哪些数据源迁移到哪些数据源。
表4 links

参数

参数类型

描述

link-config-values

link-config-values object

连接参数配置，请参见link-config-values参数说明。

creation-user

String

创建连接的用户。

name

String

连接名称。

id

Integer

连接ID。

creation-date

Long

创建连接的时间。

connector-name

String

连接器名称，对应的连接参数如下：generic-jdbc-connector：关系数据库连接。obs-connector：OBS连接。hdfs-connector：HDFS连接。hbase-connector：HBase连接、CloudTable连接。hive-connector：Hive连接。ftp-connector/sftp-connector：FTP/SFTP连接。mongodb-connector：MongoDB连接。redis-connector：Redis/DCS连接。kafka-connector：Kafka连接。dis-connector：DIS连接。elasticsearch-connector：Elasticsearch/云搜索服务连接。dli-connector：DLI连接。 http-connector：HTTP/HTTPS连接，该连接暂无连接参数。dms-kafka-connector：DMSKafka连接。

update-date

Long

更新连接的时间。

enabled

Boolean

是否激活连接，默认为“true”。

update-user

String

更新连接的用户。
表5 link-config-values

参数

参数类型

描述

configs

Array of configs objects

连接配置参数数据结构，请参见configs参数说明。

extended-configs

extended-configs object

扩展配置，请参见extended-configs参数说明。

validators

Array of strings

校验器。
表6 configs

参数

参数类型

描述

inputs

Array of Input objects

输入参数列表，列表中的每个参数为“name,value”结构，请参考inputs数据结构参数说明。在“from-config-values”数据结构中，不同的源连接类型有不同的“inputs”参数列表，请参见源端作业参数说明下的章节。在“to-config-values”数据结构中，不同的目的连接类型有不同的“inputs”参数列表，请参见目的端作业参数说明下面的子章节。在“driver-config-values”数据结构中，“inputs”具体参数请参见作业任务参数说明。

name

String

配置名称：源端作业的配置名称为“fromJobConfig”。目的端作业的配置名称为“toJobConfig”，连接的配置名称固定为“linkConfig”。

id

Integer

配置ID，由系统生成，用户无需填写。

type

String

配置类型，由系统生成，用户无需填写。值为LINK或者JOB，如果是连接管理API，则为LINK；如果是作业管理API，则为JOB。
表7 Input

参数

参数类型

描述

name

String

参数名:

  • 如果是连接管理API，则以“linkConfig.”开头，对于不同连接类型有不同的参数，具体可参见连接参数说明下相应连接的参数说明。

  • 如果是作业管理API，对于源端连接参数，则以“fromJobConfig.”开头，具体可参见源端作业参数说明下相应的源端参数说明；对于目的端连接参数，则以“toJobConfig.”开头，具体可参见目的端作业参数说明下相应的目的端参数说明；对于作业任务参数，请参见作业任务参数说明下相应的任务参数说明。

value

Object

参数值，参数名对应的值，必须填写为字符串。

type

String

值类型，如STRING、INTEGER，由系统设定，用户无需填写。
表8 extended-configs

参数

参数类型

描述

name

String

名称。

value

String

值。

请求示例

GET /v1.1/1551c7f6c808414d8e9f3c514a170f2e/clusters/6ec9a0a4-76be-4262-8697-e7af1fac7920/cdm/link/sftplink

响应示例

状态码：200

OK。

{
  "links" : [ {
    "link-config-values" : {
      "configs" : [ {
        "inputs" : [ {
          "name" : "linkConfig.server",
          "type" : "STRING",
          "value" : "100.94.8.163"
        }, {
          "name" : "linkConfig.port",
          "type" : "INTEGER",
          "value" : 22
        }, {
          "name" : "linkConfig.username",
          "type" : "STRING",
          "value" : "root"
        }, {
          "name" : "linkConfig.password",
          "type" : "STRING",
          "value" : "Add password here"
        } ],
        "name" : "linkConfig"
      } ]
    },
    "creation-user" : "cdm",
    "name" : "sftp_link",
    "creation-date" : 1516674482640,
    "connector-name" : "sftp-connector",
    "update-date" : 1516674476022,
    "enabled" : true,
    "update-user" : "cdm"
  } ]
}

状态码

状态码

描述

200

OK。

400

请求错误。

401

鉴权失败。

403

没有操作权限。

404

找不到资源。

500

服务内部错误，具体返回错误码请参考错误码。

503

服务不可用。

错误码

请参见错误码。

父主题： 连接管理