CreateCrawler - DataWorks

建立一個中繼資料採集器，並設定資料來源、採集範圍、資源群組及排程方式。

介面說明

使用場景

為指定資料來源建立中繼資料採集器，並設定採集範圍、資源群組、排程方式及擴充設定。

版本要求

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

注意事項

建立成功僅表示採集器設定已產生，不會立即執行中繼資料採集。

調試

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

調試

授權資訊

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

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

dataworks:CreateCrawler

create

*全部資源。

*

無

請求文法

POST  HTTP/1.1

請求參數

名稱	類型	必填	描述	樣本值
Name	string	是	中繼資料採集器名稱，長度不超過 128 個字元。	example_crawler
DataSourceId	integer	是	採集器關聯的資料來源 ID。資料來源需已綁定 DataWorks 工作空間，且資料來源類型與 Type 相符。	12345
Type	string	是	採集器類型。可呼叫 GetCrawlerTypeCapabilities 查詢目前區域支援的取值。	starrocks
ResourceGroupId	string	否	執行採集任務所使用的 Serverless 2.0 資源群組 ID。是否需要填寫以 GetCrawlerTypeCapabilities 返回的 RequireResourceGroup 為準。	Serverless_res_group_1234567890123456_1234567890
Scope	object	否	採集範圍設定。未傳入時，使用 GetCrawlerTypeCapabilities 返回的 DefaultScopeUnit。
Unit	string	是	採集範圍粒度。可選值以 GetCrawlerTypeCapabilities 返回的 SupportedScopeUnits 為準。	DATABASE
Items	array	否	資料庫名稱清單。僅當 Unit 為 DATABASE 時支援填寫，最多 1000 個，名稱不能為空或重複。
	string	否	單一資料庫名稱，長度不超過 256 個字元。	example_database
ExcludeRegex	string	否	採集範圍排除正規表示式。僅當 GetCrawlerTypeCapabilities 返回的 SupportExcludeRegex 為 true 時支援。	^tmp_.*
ScheduleConfig	object	否	排程設定。未傳入時使用手動排程。
Type	string	是	排程類型。MANUAL 表示手動執行，NORMAL 表示週期排程。開發環境資料來源僅支援 MANUAL；NORMAL 是否可用以 GetCrawlerTypeCapabilities 返回的 SupportSchedule 為準。	NORMAL
CronExpress	string	否	週期排程的六段式 Cron 運算式。Type 為 NORMAL 時必填；秒欄位必須為 0，排程頻率不得高於每小時一次。	0 0 2 ? * *
EnableAiComment	boolean	否	是否啟用 AI 中繼資料描述。僅當 GetCrawlerTypeCapabilities 返回的 SupportAiComment 為 true 時支援。
Options	object	否	採集器類型的擴充設定。鍵名、值類型、必填性、預設值和可選值以 GetCrawlerTypeCapabilities 返回的 SupportedOptionKeys 為準。
	string	否	單一採集器擴充設定項目的值。支援的設定項目、值類型和取值範圍以 GetCrawlerTypeCapabilities 返回的 SupportedOptionKeys 為準。	v1

DataSourceId 需要與 Type 相符。ResourceGroupId、Scope、ScheduleConfig、EnableAiComment 和 Options 的支援情況以 GetCrawlerTypeCapabilities 為準。

返回參數

名稱	類型	描述	樣本值
	object	返回結果。
RequestId	string	請求 ID。用於定位日誌，排查問題。	9252F32F-D855-549E-8898-61CF5A733050
Success	boolean	請求是否成功。
Id	integer	新建立的中繼資料採集器 ID。	1234

Id 為新建立的中繼資料採集器 ID。返回成功不表示已完成中繼資料採集。

樣本

正常返回樣本

JSON格式

{
  "RequestId": "9252F32F-D855-549E-8898-61CF5A733050",
  "Success": false,
  "Id": 1234
}

錯誤碼

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

變更歷史

更多資訊，參考變更詳情。

DataWorks：CreateCrawler