文档首页> 数据治理中心 DataArts Studio> API参考（吉隆坡区域）> 数据开发API> 待下线API> 导入连接
更新时间：2023-06-15 GMT+08:00
查看PDF

导入连接

功能介绍

将存放在OBS桶的连接文件导入到数据开发模块中，一次可以导入一个或多个连接。执行本接口之前，需要将连接文件放到OBS的桶中。

URI

  • URI格式

    POST /v1/{project_id}/connections/import

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

    参数名

    是否必选

    参数类型

    说明

    project_id

    是

    String

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

请求消息

参数说明：

参数名

是否必选

参数类型

说明

path

是

String

有OBS场景：连接定义文件在OBS上的路径，连接定义文件的格式参考导出连接的响应消息。

无OBS场景：连接定义文件在本地的路径。

params

否

List<Params>

连接参数，默认值为空。

sameNamePolicy

否

String

重名策略

  • SKIP：跳过
  • OVERWRITE： 覆盖。

    默认值是SKIP

Params 连接参数说明

参数名

是否必选

参数类型

说明

name

是

String

连接名称。

type

是

String

连接类型。

params

否

Map<String,Stri

ng>

连接参数，参数名称请参考每种类型的连接配置项说明，默认值为空。

响应消息

参数名

是否必选

参数类型

说明

taskId

是

String

任务ID，请调用查询系统任务接口获取导入状态。

示例

导入连接。

  • 请求
    POST /v1/b384b9e9ab9b4ee8994c8633aabc9505/connections/import
    {
    "path":"obs://00zyx/2019-07-02/DLF_All_DataConnections.zip",
    "sameNamePolicy":"OVERWRITE",
    "params":[
        {
            "name":"DWS",
            "type":"DWS",
            "params":{
                "clusterName":"cluster1"
            }
        },
        {
            "name":"hive",
            "type":"HIVE",
            "params":{
                "clusterName":"mrs_ymcc",
                "connectionMethod":"agent",
                "userName":"admin",
                "agentName":"cdm-donotdelete",
                "kmsKey":"KMS-42ab"
            }
        }
    ]
}
  • 成功响应

    HTTP状态码 200

    {
	"taskId":"008aae2e675933c7016759418e870000"
}
  • 失败响应

    HTTP状态码 400

    {
    "error_code":"DLF.0815",
    "error_msg":"Fail to read OBS file."
}

状态码

状态码请参见状态码。

父主题： 待下线API