全部产品
Search
文档中心

大数据开发治理平台 DataWorks:CreateDataSource - 创建数据源

更新时间:Dec 10, 2024

在指定项目空间创建一条数据源,可以是开发环境或生产环境。

接口说明

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

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
dataworks:CreateDataSourceget
*全部资源
*

请求参数

名称类型必填描述示例值
ProjectIdlong

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

该参数用来确定本次 API 调用操作使用的 DataWorks 工作空间。

2
Namestring

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

demo_holo_datasource
Typestring

数据源的类型,目前已经支持数据源类型 70+。

hologres
ConnectionPropertiesModestring

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

  • InstanceMode(实例模式)
  • UrlMode(连接串模式)
UrlMode
Descriptionstring

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

this is a holo datasource
ConnectionPropertiesstring

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

  • Dev(开发环境)
  • Prod(生产环境)

不同类型的数据源在不同的配置模式(ConnectionPropertiesMode)下具有不同的属性信息规范,请参考数据源连接信息 ConnectionProperties

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

返回参数

名称类型描述示例值
object

返回结果。

RequestIdstring

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

B62EC203-B39E-5DC1-B5B8-EB3C61707009
Idlong

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

22130

示例

正常返回示例

JSON格式

{
  "RequestId": "B62EC203-B39E-5DC1-B5B8-EB3C61707009",
  "Id": 22130
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
暂无变更历史