创建连接
功能介绍
创建一个新连接,当前支持的连接类型有DWS、DLI、SparkSQL、HIVE、RDS、CloudTable。
- 参数说明 
   
表1 URI参数说明 参数名
是否必选
参数类型
说明
project_id
是
String
项目编号,获取方法请参见项目ID和帐号ID。
 
请求消息
| 
        参数名  | 
      
        是否必选  | 
      
        参数类型  | 
      
        说明  | 
     
|---|---|---|---|
| 
        workspace  | 
      
        否  | 
      
        String  | 
      
        工作空间id。 
  | 
     
| 
        参数名  | 
      
        是否必选  | 
      
        参数类型  | 
      
        说明  | 
     
|---|---|---|---|
| 
        name  | 
      
        是  | 
      
        String  | 
      
        连接名称,只能包含四种字符:英文字母、数字、中划线和下划线,且长度小于等于100个字符。连接名称不能重复。  | 
     
| 
        type  | 
      
        是  | 
      
        String  | 
      
        连接类型,包含: 
  | 
     
| 
        config  | 
      
        否  | 
      
        Map<String,String>  | 
      
        连接的配置项,不同类型的连接配置项不同。DLI类型的连接不需要配置。config参数,其他类型的连接请参考连接配置项说明。  | 
     
| 
        description  | 
      
        否  | 
      
        String  | 
      
        描述,长度不能超过255个字符。  | 
     
| 
       参数名  | 
     
       是否必选  | 
     
       参数类型  | 
     
       说明  | 
    
|---|---|---|---|
| 
       clusterName  | 
     
       否  | 
     
       String  | 
     
       DWS集群名称。 通过DWS管理控制台获取集群名称: 
 在集群管理列表中可以获取到集群名称。 默认值为空。  | 
    
| 
       ip  | 
     
       否  | 
     
       String  | 
     
       DWS集群的访问地址。 通过DWS管理控制台获取访问地址: 
 在数据库属性标签中可以查看到内网IP,如果有多个IP地址,选择第一个IP。 默认值为空。  | 
    
| 
       port  | 
     
       否  | 
     
       String  | 
     
       DWS集群的访问端口。 通过DWS管理控制台获取访问集群的访问端口: 
 在数据库属性标签中可以获取到端口信息。 例如8000,默认值为空。  | 
    
| 
       userName  | 
     
       是  | 
     
       String  | 
     
       数据库的用户名,创建DWS集群的时输入的用户名。  | 
    
| 
       password  | 
     
       是  | 
     
       String  | 
     
       数据库的访问密码,创建DWS集群的时候输入的密码。  | 
    
| 
       sslEnable  | 
     
       是  | 
     
       boolean  | 
     
       是否使用ssl连接。  | 
    
| 
       kmsKey  | 
     
       是  | 
     
       String  | 
     
       KMS密钥名称。 通过KMS管理控制台获取密钥名称: 
 在密钥列表可以获取到密钥名称。  | 
    
| 
       agentName  | 
     
       是  | 
     
       String  | 
     
       连接代理,即CDM集群名称。 通过DataArts Studio管理控制台 > 数据集成,在批量数据迁移集群列表可以获取到集群名称。  | 
    
| 
       参数名  | 
     
       是否必选  | 
     
       参数类型  | 
     
       说明  | 
    
|---|---|---|---|
| 
       clusterName  | 
     
       是  | 
     
       String  | 
     
       MRS集群名称。 通过MRS管理控制台获取集群名称: 
 在现有集群中可以获取到集群名称,例如mrsCluster1。  | 
    
| 
       connectionMethod  | 
     
       是  | 
     
       String  | 
     
       连接方式: 
  | 
    
| 
       userName  | 
     
       否  | 
     
       String  | 
     
       MRS集群的用户名,通过代理连接的时候,是必选项。  | 
    
| 
       password  | 
     
       否  | 
     
       String  | 
     
       MRS集群的访问密码,通过代理连接的时候,是必选项。  | 
    
| 
       agentName  | 
     
       否  | 
     
       String  | 
     
       连接代理,即CDM集群名称。通过代理连接的时候,是必选项。 通过DataArts Studio管理控制台 > 数据集成,在批量数据迁移集群列表可以获取到集群名称。  | 
    
| 
       kmsKey  | 
     
       否  | 
     
       String  | 
     
       KMS密钥名称。通过代理连接的时候,是必选项。 通过KMS管理控制台获取密钥名称: 
 在密钥列表可以获取到密钥名称。  | 
    
| 
       参数名  | 
     
       是否必选  | 
     
       参数类型  | 
     
       说明  | 
    
|---|---|---|---|
| 
       clusterName  | 
     
       是  | 
     
       String  | 
     
       MRS集群名称,例如mrsCluster1  | 
    
| 
       connectionMethod  | 
     
       是  | 
     
       String  | 
     
       连接方式: 
  | 
    
| 
       userName  | 
     
       否  | 
     
       String  | 
     
       MRS集群的用户名,通过代理连接的时候,是必选项。  | 
    
| 
       password  | 
     
       否  | 
     
       String  | 
     
       MRS集群的访问密码,通过代理连接的时候,是必选。  | 
    
| 
       agentName  | 
     
       否  | 
     
       String  | 
     
       连接代理,即CDM集群名称。通过代理连接的时候,是必选项。 通过DataArts Studio管理控制台 > 数据集成,在批量数据迁移集群列表可以获取到集群名称。  | 
    
| 
       kmsKey  | 
     
       否  | 
     
       String  | 
     
       KMS密钥名称。通过代理连接的时候,是必选项。 通过KMS管理控制台获取密钥名称: 
 在密钥列表可以获取到密钥名称。  | 
    
| 
       参数名  | 
     
       是否必选  | 
     
       参数类型  | 
     
       说明  | 
    
|---|---|---|---|
| 
       ip  | 
     
       是  | 
     
       String  | 
     
       RDS的访问地址。 通过RDS管理控制台获取访问地址: 
 在连接信息标签中可以获取到内网地址。  | 
    
| 
       port  | 
     
       是  | 
     
       String  | 
     
       RDS的访问端口。 通过RDS管理控制台获取访问端口: 
 在连接信息标签中可以获取到数据库端口。  | 
    
| 
       userName  | 
     
       是  | 
     
       String  | 
     
       数据库的用户名,创建集群的时候,输入的用户名。  | 
    
| 
       password  | 
     
       是  | 
     
       String  | 
     
       数据库的访问密码,创建集群的时候,输入的密码。  | 
    
| 
       kmsKey  | 
     
       是  | 
     
       String  | 
     
       KMS密钥名称。 通过KMS管理控制台获取密钥名称: 
 在密钥列表可以获取到密钥名称。  | 
    
| 
       agentName  | 
     
       是  | 
     
       String  | 
     
       连接代理,即CDM集群名称。 通过DataArts Studio管理控制台 > 数据集成,在批量数据迁移集群列表可以获取到集群名称。  | 
    
| 
       driverName  | 
     
       是  | 
     
       String  | 
     
       驱动程序名称: 
  | 
    
| 
       driverPath  | 
     
       是  | 
     
       String  | 
     
       驱动在OBS上路径。  | 
    
| 
       参数名  | 
     
       是否必选  | 
     
       参数类型  | 
     
       说明  | 
    
|---|---|---|---|
| 
       clusterName  | 
     
       是  | 
     
       String  | 
     
       CloudTable集群名称 通过CloudTable管理控制台获取集群名称: 
 在集群模式中可以获取到集群名称。  | 
    
| 
       参数名  | 
     
       是否必选  | 
     
       参数类型  | 
     
       说明  | 
    
|---|---|---|---|
| 
       ip  | 
     
       是  | 
     
       String  | 
     
       主机的地址  | 
    
| 
       port  | 
     
       是  | 
     
       String  | 
     
       主机的SSH端口号  | 
    
| 
       userName  | 
     
       是  | 
     
       String  | 
     
       主机的登录用户名  | 
    
| 
       password  | 
     
       是  | 
     
       String  | 
     
       主机的登录方式为密码时,填写主机的登录密码。  | 
    
| 
       agentName  | 
     
       是  | 
     
       String  | 
     
       连接代理,即CDM集群名称。 通过DataArts Studio管理控制台 > 数据集成,在批量数据迁移集群列表可以获取到集群名称。  | 
    
| 
       kmsKey  | 
     
       是  | 
     
       String  | 
     
       KMS密钥名称。 通过KMS管理控制台获取密钥名称: 
 在密钥列表可以获取到密钥名称。  | 
    
响应消息
无
示例
创建一个连接。
- 请求
    
POST /v1/b384b9e9ab9b4ee8994c8633aabc9505/connections
{ "name":"connection1", "type":"DWS", "config":{ "clusterName":"test", "userName":"dbadmin", "password":"*********", "kmsKey":"cdm-dlf", "agentName":"cdm-donotdelete", "sslEnable":false } } 
- 成功响应
 - 失败响应
   
   
{ "error_code":"DLF.6309", "error_msg":"The name already exists." } 
状态码
状态码请参见状态码。