CreateDataSource_大数据开发治理平台 DataWorks_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

  1. 需要购买 DataWorks 基础版及以上版本才能使用。
  2. 需要在 DataWorks 项目空间中具有如下至少一种角色:
  • 租户所有者、空间管理员、项目所有者、运维

流控信息

当前云产品API请求速率暂未透出。

授权信息

当前云产品暂无权限信息透出。

请求参数

字段名称字段详情
ProjectIdinteger<int64>

DataWorks 工作空间的 ID。您可以登录 DataWorks 控制台,进入工作空间管理页面获取 ID。展开详情

注意 该字段类型为 Long,在序列化/反序列化的过程中可能导致精度丢失,请注意数值不得大于 9007199254740991。
示例值:2参考取值来源:
    CreateProject
取值 >= 0
Namestring

数据源的名称,由字母、数字、下划线组合,且不能以数字和下划线开头,最长 255 个字符。

示例值:demo_holo_datasource
Typestring

数据源的类型,目前已经支持数据源类型 70+,数据源类型枚举说明参考文档:数据源类型列表

示例值:hologres
ConnectionPropertiesModestring

数据源添加的类别,不同 Type 下会有不同的子类型,对应有不同的参数约束,以 MySQL 数据源举例有:展开详情

示例值:UrlMode枚举值:UrlModeInstanceModeCdhMode
Descriptionstring

数据源描述信息,长度不超过 3000 个字符。

示例值:this is a holo datasource
ConnectionPropertiesstring

数据源的具体连接配置信息,包括连接地址、访问身份、环境信息等。数据源环境 envType 信息是此对象的成员属性,包括展开详情

示例值:{ "envType": "Prod", "regionId": "cn-beijing", "instanceId": "hgprecn-cn-x0r3oun4k001", "database": "testdb", "securityProtocol": "authTypeNone", "authType": "Executor", "authIdentity": "1107550004253538" }

返回参数

字段名称字段详情
RequestIdstring

请求 ID。用于定位日志,排查问题。

示例值:B62EC203-B39E-5DC1-B5B8-EB3C6****
Idinteger<int64>

返回创建的数据源 ID,数据源的唯一标识符。

注意 请注意,该值为 Long 类型,在某些语言中可能存在精度丢失的风险,请小心使用。
示例值:22130

返回示例

变更历史

暂无变更历史

相关示例