文档首页/ 数据治理中心 DataArts Studio/ 更多文档/ API参考（吉隆坡区域）/ 数据开发API/ 连接管理API/ 查询连接列表
更新时间：2023-06-15 GMT+08:00
查看PDF
分享

查询连接列表

功能介绍

查询连接列表。

URI

  • URI格式

    GET /v1/{project_id}/connections?offset={offset}&limit={limit}&connectionName={connectionName}

  • 参数说明
    表1 URI参数说明

    参数名

    是否必选

    参数类型

    说明

    project_id

    是

    String

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

    offset

    否

    Integer

    偏移量，取值范围大于等于0，默认值为0。

    limit

    否

    Integer

    分页返回结果，指定每页最大记录数。范围[1,100]

    默认值：10

    connectionName

    否

    String

    连接名称

请求消息

表2 请求Header参数

参数名

是否必选

参数类型

说明

workspace

否

String

工作空间id。

  • 如果不设置该参数，默认查询default工作空间下的数据。
  • 如果需要查询其他工作空间的数据，需要带上该消息头。

响应消息

参数名

是否必选

参数类型

说明

total

是

Integer

总的连接个数

connections

是

List<Connections>

连接列表
表3 connections参数说明

参数名

是否必选

参数类型

说明

name

是

String

连接名称，只能包含四种字符：英文字母、数字、中划线和下划线，且长度小于等于100个字符。连接名称不能重复。

type

是

String

连接类型，包含：

  • DWS
  • DLI
  • SparkSQL
  • HIVE
  • RDS
  • CloudTable
  • HOST

config

否

Map<String,String>

连接的配置项，不同类型的连接配置项不同。DLI类型的连接不需要配置。config参数，其他类型的连接请参考连接配置项说明。

description

否

String

描述，长度不能超过255个字符。

示例

查询连接列表。

  • 请求 
    GET /v1/b384b9e9ab9b4ee8994c8633aabc9505/connections
  • 成功响应

    HTTP状态码 200

    {
    "total":1,
    "connections":[
        {
            "name":"connection1",
            "type":"DWS",
            "config":{
                "clusterName":"test",
                "userName":"dbadmin",
                "password":"*********",
                "kmsKey":"cdm-dlf",
                "agentName":"cdm-donotdelete",
                "sslEnable":false
            }
        }
    ]
}
  • 失败响应

    HTTP状态码 400

    {
    "error_code":"DLF.3051",
    "error_msg":"The request parameter is invalid."
}
父主题： 连接管理API