全部產品
Search
文件中心

DataWorks:CreateDataSource - 建立資料來源

更新時間:Mar 21, 2026

在指定專案空間建立一條資料來源,可以是開發環境或生產環境。

介面說明

  1. 需要購買 DataWorks 基礎版及以上版本才能使用。

  2. 需要在 DataWorks 專案空間中具有如下至少一種角色:

  • 租戶所有者、空間管理員、專案所有者、營運

調試

您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊,可以在RAM權限原則語句的Action元素中使用,用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下:

  • 操作:是指具體的許可權點。

  • 存取層級:是指每個操作的存取層級,取值為寫入(Write)、讀取(Read)或列出(List)。

  • 資源類型:是指操作中支援授權的資源類型。具體說明如下:

    • 對於必選的資源類型,用前面加 * 表示。

    • 對於不支援資源級授權的操作,用全部資源表示。

  • 條件關鍵字:是指雲產品自身定義的條件關鍵字。

  • 關聯操作:是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權,操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

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 資料來源舉例有:

  • InstanceMode(執行個體模式)

  • UrlMode(串連串模式)

UrlMode

Description

string

資料來源描述資訊,長度不超過 3000 個字元。

this is a holo datasource

ConnectionProperties

string

資料來源的具體串連配置資訊,包括串連地址、訪問身份、環境資訊等。資料來源環境 envType 資訊是此對象的成員屬性,包括

  • Dev(開發環境)

  • Prod(生產環境)

不同類型的資料來源在不同的配置模式(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
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊,參考變更詳情