在指定项目空间创建一条数据源,可以是开发环境或生产环境。
接口说明
需要购买 DataWorks 基础版及以上版本才能使用。
需要在 DataWorks 项目空间中具有如下至少一种角色:
租户所有者、空间管理员、项目所有者、运维
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
dataworks:CreateDataSource |
get |
*全部资源
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| ProjectId |
integer |
是 |
DataWorks 工作空间的 ID。您可以登录 DataWorks 控制台,进入工作空间管理页面获取 ID。 该参数用来确定本次 API 调用操作使用的 DataWorks 工作空间。 |
2 |
| Name |
string |
是 |
数据源的名称,由字母、数字、下划线组合,且不能以数字和下划线开头,最长 255 个字符。 |
demo_holo_datasource |
| Type |
string |
是 |
数据源的类型,目前已经支持数据源类型 70+,数据源类型枚举说明参考文档:数据源类型列表 |
hologres |
| ConnectionPropertiesMode |
string |
是 |
数据源添加的类别,不同 Type 下会有不同的子类型,对应有不同的参数约束,以 MySQL 数据源举例有:
|
UrlMode |
| Description |
string |
否 |
数据源描述信息,长度不超过 3000 个字符。 |
this is a holo datasource |
| ConnectionProperties |
string |
是 |
数据源的具体连接配置信息,包括连接地址、访问身份、环境信息等。数据源环境 envType 信息是此对象的成员属性,包括
不同类型的数据源在不同的配置模式(ConnectionPropertiesMode)下具有不同的属性信息规范,请参考数据源连接信息 ConnectionProperties |
{ "envType": "Prod", "regionId": "cn-beijing", "instanceId": "hgprecn-cn-x0r3oun4k001", "database": "testdb", "securityProtocol": "authTypeNone", "authType": "Executor", "authIdentity": "1107550004253538" } |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
返回结果。 |
||
| RequestId |
string |
请求 ID。用于定位日志,排查问题。 |
B62EC203-B39E-5DC1-B5B8-EB3C6**** |
| Id |
integer |
返回创建的数据源 ID,数据源的唯一标识符。 |
22130 |
示例
正常返回示例
JSON格式
{
"RequestId": "B62EC203-B39E-5DC1-B5B8-EB3C6****",
"Id": 22130
}
错误码
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。