UpdateCrawler - DataWorks

更新指定中繼資料採集器的資源群組、採集範圍、排程和擴充配置。

介面說明

使用場景

部分更新指定中繼資料採集器的資源群組、採集範圍、排程、AI 中繼資料描述或擴充配置。

版本要求

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

注意事項

至少需要提供一個可更新欄位；未提供的欄位保持不變。

調試

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

調試

授權資訊

當前API暫無授權資訊透出。

請求文法

POST  HTTP/1.1

請求參數

名稱	類型	必填	描述	樣本值
Id	integer	是	中繼資料採集器 ID。您可以透過 ListCrawlers 查詢。	1234
ResourceGroupId	string	否	執行採集任務使用的 Serverless 2.0 資源群組 ID。是否支援以及是否需要填寫以 GetCrawlerTypeCapabilities 返回的能力為準；未傳入時保持不變。	Serverless_res_group_1234567890123456_1234567890
Scope	object	否	採集範圍配置。傳入時更新採集範圍；未傳入時保持不變。
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

至少提供 ResourceGroupId、Scope、ScheduleConfig、EnableAiComment 或 Options 中的一項。未提供的欄位保持不變。

返回參數

名稱	類型	描述	樣本值
	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：UpdateCrawler