文档首页/ 数据仓库服务 DWS/ 更多文档/ API参考（吉隆坡区域）/ API说明/ 数据源/ 创建数据源
更新时间：2025-09-18 GMT+08:00
在线调试
CLI示例
查看PDF
分享

创建数据源

功能介绍

该接口用于创建一个数据源。

调用方法

请参见如何调用API。

URI

POST /v1.0/{project_id}/clusters/{cluster_id}/ext-data-sources

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

项目ID。获取方法请参见获取项目ID。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

cluster_id

是

String

参数解释：

集群ID。获取方法请参见获取集群ID。

约束限制：

必须是有效的dws集群ID。

取值范围：

36位UUID。

默认取值：

不涉及。

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

data_source_id

否

String

参数解释：

外部数据源ID。当数据源为MRS时为必选字段。

取值范围：

不涉及。

type

是

String

参数解释：

数据源类型。

取值范围：

不涉及。

data_source_name

是

String

参数解释：

外部数据源名称。

取值范围：

仅可包含大小写字母、数字、下划线，1到64个字符。

user_name

是

String

参数解释：

用户名。数据源类型为OBS时，传对应OBS委托名称。

取值范围：

仅可包含大小写字母、数字、下划线，3到20个字符。

user_pwd

否

String

参数解释：

密码。当数据源为MRS时为必选字段。

取值范围：

不涉及。

description

否

String

参数解释：

描述。

取值范围：

除!<>'=&等特殊字符外的字符。长度256个字符以内。

reboot

否

Boolean

参数解释：

是否重启集群。

取值范围：

不涉及。

connect_info

否

String

参数解释：

连接的数据库。当数据源为OBS时为必选字段。

取值范围：

不涉及。

响应参数

状态码：200

表3 响应Body参数

参数

参数类型

描述

id

String

参数解释：

数据源ID。

取值范围：

不涉及。

job_id

String

参数解释：

创建数据源任务ID。

取值范围：

不涉及。

请求示例

创建名为source1的OBS数据源，用户名为“DWSAccessOBS”，连接gaussdb数据库。

POST https://{Endpoint} /v1.0/89cd04f168b84af6be287f71730fdb4b/clusters/4ca46bf1-5c61-48ff-b4f3-0ad4e5e3ba90/ext-data-sources

{
  "type" : "OBS",
  "data_source_name" : "source1",
  "user_name" : "DWSAccessOBS",
  "connect_info" : "gaussdb",
  "description" : "description"
}

响应示例

状态码：200

请求下发成功。

{
  "id" : "d303f19c-fbd1-4716-ae04-07d1ff358f22",
  "job_id" : "2c9081c88418ed420184197c8bc80001"
}

状态码

状态码

描述

200

请求下发成功。

400

请求错误。

401

鉴权失败。

403

没有操作权限。

404

找不到资源。

500

服务内部错误。

503

服务不可用。
父主题： 数据源