GetCrawler - DataWorks

查詢指定中繼資料採集器的設定、狀態和最近一次執行資訊。

介面說明

使用場景

查詢指定中繼資料採集器的設定、可用狀態和最近一次執行資訊。

版本要求

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

注意事項

採集器尚未執行時，最近執行狀態和工作執行個體 ID 可能為空。

調試

您可以在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	請求是否成功。
Crawler	object	中繼資料採集器詳情。
Id	integer	採集器 ID。	1234
Name	string	採集器名稱。	example_crawler
DataSourceId	integer	資料來源 ID。	12345
Type	string	採集器類型。	starrocks
Status	string	採集器狀態。採集器設定有效且關聯資料來源存在時為 VALID，否則為 INVALID。	VALID
MetaEntityId	string	採集器關聯的中繼實體 ID，可用於銜接中繼資料查詢 API。	starrocks:example-instance
ProjectId	integer	DataWorks 工作空間 ID。	100
EnvType	string	DataWorks 環境類型。取值：Dev、Prod。	Prod
ResourceGroupId	string	執行採集工作使用的 Serverless 2.0 資源群組 ID。	Serverless_res_group_1234567890123456_1234567890
ScheduleConfig	object	排程設定。
Type	string		NORMAL
CronExpress	string		0 0 2 ? * *
LastRunStatus	string	最近一次執行狀態。取值：WAITING、RUNNING、SUCCESS、ERROR、SHUTDOWN。採集器尚未執行時可能為空。	SUCCESS
Owner	string	採集器負責人的 DataWorks 使用者 ID。	1000
CreateTime	integer	建立時間，毫秒級 Unix 時間戳記。	1710239005403
ModifyTime	integer	修改時間，毫秒級 Unix 時間戳記。	1710239005403
Scope	object	採集範圍設定。
Unit	string		DATABASE
Items	array
	string		example_database
ExcludeRegex	string		^tmp_.*
EnableAiComment	boolean	是否啟用 AI 中繼資料描述。
Options	object	採集器類型擴充設定。
	string	單個採集器擴充設定項目的值。	true
LastRunTaskInstanceId	integer	最近一次執行關聯的 DataWorks 工作執行個體 ID。採集器尚未執行時可能為空。	1234
TaskId	integer	採集器關聯的 DataWorks 排程工作 ID，可用於呼叫 GetTask 查詢工作定義。	1234

Crawler 返回採集器設定、可用狀態和最近一次執行資訊。

樣本

正常返回樣本

JSON格式

{
  "RequestId": "9252F32F-D855-549E-8898-61CF5A733050",
  "Success": false,
  "Crawler": {
    "Id": 1234,
    "Name": "example_crawler",
    "DataSourceId": 12345,
    "Type": "starrocks",
    "Status": "VALID",
    "MetaEntityId": "starrocks:example-instance",
    "ProjectId": 100,
    "EnvType": "Prod",
    "ResourceGroupId": "Serverless_res_group_1234567890123456_1234567890",
    "ScheduleConfig": {
      "Type": "NORMAL",
      "CronExpress": "0 0 2 ? * *"
    },
    "LastRunStatus": "SUCCESS",
    "Owner": "1000",
    "CreateTime": 1710239005403,
    "ModifyTime": 1710239005403,
    "Scope": {
      "Unit": "DATABASE",
      "Items": [
        "example_database"
      ],
      "ExcludeRegex": "^tmp_.*"
    },
    "EnableAiComment": false,
    "Options": {
      "key": "true"
    },
    "LastRunTaskInstanceId": 1234,
    "TaskId": 1234
  }
}

錯誤碼

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

變更歷史

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

DataWorks：GetCrawler