全部產品
Search
文件中心

DataWorks:RunCrawler

更新時間:Sep 03, 2026

觸發指定中繼資料採集器執行,並傳回受理狀態及關聯的工作執行個體資訊。

介面說明

使用場景

提交指定中繼資料採集器的執行請求。

推薦流程

  1. 呼叫 ListCrawlers 查詢可執行的採集器 ID。

  2. 呼叫本介面提交執行請求。

  3. 呼叫 ListCrawlerRuns 查詢最終執行狀態。

版本要求

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

費用說明

執行採集工作會使用運算資源,可能產生費用,具體以實際使用的資源群組和 DataWorks 計費規則為準。

當採集器已啟用 AI 中繼資料描述功能(EnableAiComment=true)時,採集中繼資料並產生 AI 說明會消耗 Token。Token 贈送額度及超出額度後的計費規則,請參閱 Data Agent 費用。

注意事項

介面成功僅表示執行請求已受理,不表示採集工作已經完成。

調試

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

調試

授權資訊

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

請求文法

POST  HTTP/1.1

請求參數

名稱

類型

必填

描述

樣本值

Id

integer

是

中繼資料採集器 ID。您可以透過 ListCrawlers 查詢。

1234

Id 可透過 ListCrawlers 查詢。

返回參數

名稱

類型

描述

樣本值

object

傳回結果。

RequestId

string

請求 ID。用於定位日誌,排查問題。

9252F32F-D855-549E-8898-61CF5A733050

Success

boolean

請求是否成功。

Id

integer

中繼資料採集器 ID。

1234

RunAccepted

boolean

執行請求是否已受理。true 表示已受理,不表示採集工作已經完成。

RunStatus

string

提交後的初始執行狀態。執行請求成功受理時為 WAITING;最終狀態請透過 ListCrawlerRuns 查詢。

WAITING

TaskInstanceId

integer

關聯的 DataWorks 工作執行個體 ID。該欄位可能為空,最終執行記錄請透過 ListCrawlerRuns 查詢。

1234

RunAccepted 表示執行請求是否已受理;請使用 ListCrawlerRuns 查詢最終狀態。TaskInstanceId 可能為空。

樣本

正常返回樣本

JSON格式

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

錯誤碼

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

變更歷史

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