GetSemanticJobDetail - DataWorks

使用 RunSemanticJob 或 ListSemanticJobRuns 返回的 ExecutorJobId 查詢執行器狀態與執行配置。

介面說明

使用場景

查詢某次語意任務執行在執行器側的詳細狀態和執行資訊，用於輪詢執行進度或排查執行失敗。

呼叫流程

呼叫 RunSemanticJob 或 ListSemanticJobRuns 取得 ExecutorJobId。
使用任務定義返回的 ProjectId 作為本介面的 ProjectId。
根據 Data 中的執行器詳情判斷目前狀態；任務仍在執行時可繼續輪詢本介面。

關聯操作

需要日誌時呼叫 GetSemanticJobLog；需要停止執行時呼叫 KillSemanticJob。

調試

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

調試

授權資訊

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

請求參數

名稱	類型	必填	描述	樣本值
ExecutorJobId	string	是	執行器任務識別碼，使用 RunSemanticJob 回應的 Data.ExecutorJobId 或 ListSemanticJobRuns 記錄中的 ExecutorJobId。	exec-job-demo
ProjectId	integer	是	任務所屬 DataWorks 工作空間 ID，使用 CreateSemanticJob 回應或 ListSemanticJobs 清單項目的 ProjectId。	100

請根據各請求欄位的說明建構呼叫參數。

返回參數

名稱	類型	描述	樣本值
	object	查詢執行器執行詳情的標準回應。Data 是指定 ExecutorJobId 目前返回的執行器詳情。
RequestId	string	請求 ID。用於定位日誌和排查問題。	676271D6-53B4-57BE-89FA-72F7AE1418DF
Success	boolean	請求是否成功。
Data	object	執行器返回的任務詳情，用於判斷執行狀態並檢視實際生效的執行配置。
ExecutorJobId	string	執行器任務識別碼。	exec-job-demo
FileType	integer	執行器節點類型編碼；語意任務使用 Shell 節點編碼 6。	6
ProjectId	integer	執行器任務關聯的 DataWorks 工作空間 ID。	100
Datasource	string	執行器任務使用的資料來源識別碼。	maxcompute
CodeParameters	string	執行器返回的程式碼參數資訊，用於排查本次執行配置。	--limit 100
Env	string	執行器返回的執行環境識別碼。	PROD
CustomerName	string	執行器任務的客戶識別碼。	meta_semantic
CurrentSqlIndex	integer	執行器目前處理的 SQL 片段索引。	0
ExecTypes	array	執行器返回的執行類型編碼清單。
	integer	執行器返回的執行類型編碼清單。	6
Statuses	array	執行器返回的狀態編碼清單；用於判斷任務目前或最終狀態。
	integer	執行器返回的任務狀態編碼清單；成功狀態包含 3。	3
AdvanceSettings	object	執行器返回的進階執行設定。
ResourceUrls	array<object>	執行器任務關聯的資源位址清單。
	object	執行器返回的資源位址清單。
ResourceGroupId	string	實際執行該任務的資源群組識別碼。	rg-demo

回應欄位含義和後續呼叫關係請參閱各欄位說明。

樣本

正常返回樣本

JSON格式

{
  "RequestId": "676271D6-53B4-57BE-89FA-72F7AE1418DF",
  "Success": false,
  "Data": {
    "ExecutorJobId": "exec-job-demo",
    "FileType": 6,
    "ProjectId": 100,
    "Datasource": "maxcompute",
    "CodeParameters": "--limit 100",
    "Env": "PROD",
    "CustomerName": "meta_semantic",
    "CurrentSqlIndex": 0,
    "ExecTypes": [
      6
    ],
    "Statuses": [
      3
    ],
    "AdvanceSettings": {
      "test": "test",
      "test2": 1
    },
    "ResourceUrls": [
      {
        "test": "test",
        "test2": 1
      }
    ],
    "ResourceGroupId": "rg-demo"
  }
}

錯誤碼

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

變更歷史

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