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

编辑连接

功能介绍

编辑修改连接的配置。

URI

  • URI格式

    PUT /v1/{project_id}/connections/{connection_name}?ischeck=true

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

    参数名

    是否必选

    参数类型

    说明

    project_id

    是

    String

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

    connection_name

    是

    String

    连接名称。

    ischeck

    否

    String

    是否校验，默认否。

请求消息

表2 请求Header参数

参数名

是否必选

参数类型

说明

workspace

否

String

工作空间id。

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

参数名

是否必选

参数类型

说明

name

是

String

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

type

是

String

连接类型，包含：

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

config

否

Map<String,String>

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

description

否

String

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

响应消息

无

示例

修改连接。

  • 请求 
    PUT /v1/b384b9e9ab9b4ee8994c8633aabc9505/connections/connection1?ischeck=true
{
    "name":"connection1",
    "type":"DWS",
    "config":{
	    "clusterName":"test",
	    "userName":"dbadmin",
            "password":"*********",
	    "kmsKey":"cdm-dlf",		
	    "agentName":"cdm-donotdelete",		
	    "sslEnable":false
    }
}
  • 成功响应

    HTTP状态码 204

  • 失败响应

    HTTP状态码 400

    {
    "error_code":"DLF.6322",
    "error_msg":"The data connection does not exist."
}

状态码

状态码请参见状态码。

父主题： 连接管理API