计算
弹性云服务器 ECS
Flexus云服务
裸金属服务器 BMS
弹性伸缩 AS
镜像服务 IMS
专属主机 DeH
函数工作流 FunctionGraph
云手机服务器 CPH
Huawei Cloud EulerOS
网络
虚拟私有云 VPC
弹性公网IP EIP
虚拟专用网络 VPN
弹性负载均衡 ELB
NAT网关 NAT
云专线 DC
VPC终端节点 VPCEP
云连接 CC
企业路由器 ER
企业交换机 ESW
全球加速 GA
安全与合规
安全技术与应用
Web应用防火墙 WAF
企业主机安全 HSS
云防火墙 CFW
安全云脑 SecMaster
DDoS防护 AAD
数据加密服务 DEW
数据库安全服务 DBSS
云堡垒机 CBH
数据安全中心 DSC
云证书管理服务 CCM
边缘安全 EdgeSec
威胁检测服务 MTD
CDN与智能边缘
内容分发网络 CDN
CloudPond云服务
智能边缘云 IEC
迁移
主机迁移服务 SMS
对象存储迁移服务 OMS
云数据迁移 CDM
迁移中心 MGC
大数据
MapReduce服务 MRS
数据湖探索 DLI
表格存储服务 CloudTable
云搜索服务 CSS
数据接入服务 DIS
数据仓库服务 GaussDB(DWS)
数据治理中心 DataArts Studio
数据可视化 DLV
数据湖工厂 DLF
湖仓构建 LakeFormation
企业应用
云桌面 Workspace
应用与数据集成平台 ROMA Connect
云解析服务 DNS
专属云
专属计算集群 DCC
IoT物联网
IoT物联网
设备接入 IoTDA
智能边缘平台 IEF
用户服务
账号中心
费用中心
成本中心
资源中心
企业管理
工单管理
国际站常见问题
ICP备案
我的凭证
支持计划
客户运营能力
合作伙伴支持计划
专业服务
区块链
区块链服务 BCS
Web3节点引擎服务 NES
解决方案
SAP
高性能计算 HPC
视频
视频直播 Live
视频点播 VOD
媒体处理 MPC
实时音视频 SparkRTC
数字内容生产线 MetaStudio
存储
对象存储服务 OBS
云硬盘 EVS
云备份 CBR
存储容灾服务 SDRS
高性能弹性文件服务 SFS Turbo
弹性文件服务 SFS
云硬盘备份 VBS
云服务器备份 CSBS
数据快递服务 DES
专属分布式存储服务 DSS
容器
云容器引擎 CCE
容器镜像服务 SWR
应用服务网格 ASM
华为云UCS
云容器实例 CCI
管理与监管
云监控服务 CES
统一身份认证服务 IAM
资源编排服务 RFS
云审计服务 CTS
标签管理服务 TMS
云日志服务 LTS
配置审计 Config
资源访问管理 RAM
消息通知服务 SMN
应用运维管理 AOM
应用性能管理 APM
组织 Organizations
优化顾问 OA
IAM 身份中心
云运维中心 COC
资源治理中心 RGC
应用身份管理服务 OneAccess
数据库
云数据库 RDS
文档数据库服务 DDS
数据管理服务 DAS
数据复制服务 DRS
云数据库 GeminiDB
云数据库 GaussDB
分布式数据库中间件 DDM
数据库和应用迁移 UGO
云数据库 TaurusDB
人工智能
人脸识别服务 FRS
图引擎服务 GES
图像识别 Image
内容审核 Moderation
文字识别 OCR
AI开发平台ModelArts
图像搜索 ImageSearch
对话机器人服务 CBS
华为HiLens
视频智能分析服务 VIAS
语音交互服务 SIS
应用中间件
分布式缓存服务 DCS
API网关 APIG
微服务引擎 CSE
分布式消息服务Kafka版
分布式消息服务RabbitMQ版
分布式消息服务RocketMQ版
多活高可用服务 MAS
事件网格 EG
企业协同
华为云会议 Meeting
云通信
消息&短信 MSGSMS
云生态
合作伙伴中心
云商店
开发者工具
SDK开发指南
API签名指南
Terraform
华为云命令行工具服务 KooCLI
其他
产品价格详情
系统权限
管理控制台
客户关联华为云合作伙伴须知
消息中心
公共问题
开发与运维
应用管理与运维平台 ServiceStage
软件开发生产线 CodeArts
需求管理 CodeArts Req
部署 CodeArts Deploy
性能测试 CodeArts PerfTest
编译构建 CodeArts Build
流水线 CodeArts Pipeline
制品仓库 CodeArts Artifact
测试计划 CodeArts TestPlan
代码检查 CodeArts Check
代码托管 CodeArts Repo
云应用引擎 CAE
开天aPaaS
云消息服务 KooMessage
云手机服务 KooPhone
云空间服务 KooDrive

创建连接

更新时间:2023-06-15 GMT+08:00

功能介绍

创建一个新连接,当前支持的连接类型有DWS、DLI、SparkSQL、HIVE、RDS、CloudTable。

URI

  • URI格式

    POST /v1/{project_id}/connections

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

    参数名

    是否必选

    参数类型

    说明

    project_id

    String

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

请求消息

表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个字符。

表4 DWS类型的连接配置项说明

参数名

是否必选

参数类型

说明

clusterName

String

DWS集群名称。

通过DWS管理控制台获取集群名称:

  1. 登录管理控制台。
  2. 单击“数据仓库服务”,左侧列表选择集群管理。

在集群管理列表中可以获取到集群名称。

默认值为空。

ip

String

DWS集群的访问地址。

通过DWS管理控制台获取访问地址:

  1. 登录管理控制台。
  2. 单击“数据仓库服务”,左侧列表选择集群管理。
  3. 单击集群名称,进入集群基本信息页面。

在数据库属性标签中可以查看到内网IP,如果有多个IP地址,选择第一个IP。

默认值为空。

port

String

DWS集群的访问端口。

通过DWS管理控制台获取访问集群的访问端口:

  1. 登录管理控制台。
  2. 单击“数据仓库服务”,左侧列表选择集群管理。
  3. 单击集群名称,进入集群基本信息页面。

在数据库属性标签中可以获取到端口信息。

例如8000,默认值为空。

userName

String

数据库的用户名,创建DWS集群的时输入的用户名。

password

String

数据库的访问密码,创建DWS集群的时候输入的密码。

sslEnable

boolean

是否使用ssl连接。

kmsKey

String

KMS密钥名称。

通过KMS管理控制台获取密钥名称:

  1. 登录管理控制台。
  2. 单击“密钥管理服务”,左侧列表选择密钥管理。

在密钥列表可以获取到密钥名称。

agentName

String

连接代理,即CDM集群名称。

通过DataArts Studio管理控制台 > 数据集成,在批量数据迁移集群列表可以获取到集群名称。

表5 Spark SQL类型的连接配置项说明

参数名

是否必选

参数类型

说明

clusterName

String

MRS集群名称。

通过MRS管理控制台获取集群名称:

  1. 登录管理控制台。
  2. 单击“MapReduce服务”,左侧列表选择现有集群。

在现有集群中可以获取到集群名称,例如mrsCluster1。

connectionMethod

String

连接方式:

  • agent :通过代理连接。
  • direct :直接连接。

userName

String

MRS集群的用户名,通过代理连接的时候,是必选项。

password

String

MRS集群的访问密码,通过代理连接的时候,是必选项。

agentName

String

连接代理,即CDM集群名称。通过代理连接的时候,是必选项。

通过DataArts Studio管理控制台 > 数据集成,在批量数据迁移集群列表可以获取到集群名称。

kmsKey

String

KMS密钥名称。通过代理连接的时候,是必选项。

通过KMS管理控制台获取密钥名称:

  1. 登录管理控制台。
  2. 单击“密钥管理服务”,左侧列表选择密钥管理。

在密钥列表可以获取到密钥名称。

表6 Hive类型的连接配置项说明

参数名

是否必选

参数类型

说明

clusterName

String

MRS集群名称,例如mrsCluster1

connectionMethod

String

连接方式:

  • agent:通过代理连接。
  • direct :直接连接。

userName

String

MRS集群的用户名,通过代理连接的时候,是必选项。

password

String

MRS集群的访问密码,通过代理连接的时候,是必选。

agentName

String

连接代理,即CDM集群名称。通过代理连接的时候,是必选项。

通过DataArts Studio管理控制台 > 数据集成,在批量数据迁移集群列表可以获取到集群名称。

kmsKey

String

KMS密钥名称。通过代理连接的时候,是必选项。

通过KMS管理控制台获取密钥名称:

  1. 登录管理控制台。
  2. 单击“密钥管理服务”,左侧列表选择密钥管理。

在密钥列表可以获取到密钥名称。

表7 RDS类型的连接配置项说明

参数名

是否必选

参数类型

说明

ip

String

RDS的访问地址。

通过RDS管理控制台获取访问地址:

  1. 登录管理控制台。
  2. 单击“关系型数据库服务”,从左侧列表选择实例管理。
  3. 单击某一个实例名称,进入实例基本信息页面。

在连接信息标签中可以获取到内网地址。

port

String

RDS的访问端口。

通过RDS管理控制台获取访问端口:

  1. 登录管理控制台。
  2. 单击“关系型数据库服务”,左侧列表选择实例管理。
  3. 单击某一个实例名称,进入实例基本信息页面。

在连接信息标签中可以获取到数据库端口。

userName

String

数据库的用户名,创建集群的时候,输入的用户名。

password

String

数据库的访问密码,创建集群的时候,输入的密码。

kmsKey

String

KMS密钥名称。

通过KMS管理控制台获取密钥名称:

  1. 登录管理控制台。
  2. 单击“密钥管理服务”,左侧列表选择密钥管理。

在密钥列表可以获取到密钥名称。

agentName

String

连接代理,即CDM集群名称。

通过DataArts Studio管理控制台 > 数据集成,在批量数据迁移集群列表可以获取到集群名称。

driverName

String

驱动程序名称:

  • com.mysql.jdbc.Driver
  • org.postgresql.Driver

driverPath

String

驱动在OBS上路径。

表8 CloudTable类型的连接配置项说明

参数名

是否必选

参数类型

说明

clusterName

String

CloudTable集群名称

通过CloudTable管理控制台获取集群名称:

  1. 登录管理控制台。
  2. 单击“表格存储服务”,左侧列表选择集群模式。

在集群模式中可以获取到集群名称。

表9 HOST类型的连接配置项说明

参数名

是否必选

参数类型

说明

ip

String

主机的地址

port

String

主机的SSH端口号

userName

String

主机的登录用户名

password

String

主机的登录方式为密码时,填写主机的登录密码。

agentName

String

连接代理,即CDM集群名称。

通过DataArts Studio管理控制台 > 数据集成,在批量数据迁移集群列表可以获取到集群名称。

kmsKey

String

KMS密钥名称。

通过KMS管理控制台获取密钥名称:

  1. 登录管理控制台。
  2. 单击“密钥管理服务”,左侧列表选择密钥管理。

在密钥列表可以获取到密钥名称。

响应消息

示例

创建一个连接。

  • 请求
    POST /v1/b384b9e9ab9b4ee8994c8633aabc9505/connections
    {
        "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.6309",
        "error_msg":"The name already exists."
    }

状态码

状态码请参见状态码

我们使用cookie来确保您的高速浏览体验。继续浏览本站,即表示您同意我们使用cookie。 详情

文档反馈

文档反馈

意见反馈

0/500

标记内容

同时提交标记内容