調用GetTaskInstance API擷取任務執行個體詳細資料-巨量資料開發治理平台 DataWorks-阿里雲

擷取指定的任務執行個體的詳細資料。

介面說明

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

調試

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

調試

授權資訊

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

請求參數

名稱	類型	必填	描述	樣本值
Id	integer	是	任務執行個體的唯一識別碼	1234

返回參數

名稱	類型	描述	樣本值
	object	傳回值
RequestId	string	請求的 ID，用於定位日誌，排查問題。	22C97E95-F023-56B5-8852-B1A77****
TaskInstance	object	任務執行個體的詳細資料。
TaskId	integer	對應任務的 ID。	1234
TaskType	string	對應任務的類型。	ODPS_SQL
TaskName	string	對應任務的名稱。	SQL node
Description	string	描述資訊。	test
WorkflowId	integer	所屬工作流程的 ID。	1234
WorkflowName	string	所屬工作流程的名稱。	Test workflow
TriggerType	string	觸發方式類型。可通過調用 GetTask 介面的返回參數 Trigger.Type 擷取觸發方式類型。 Scheduler：調度周期觸發 Manual：手動觸發	Scheduler
TriggerRecurrence	string	觸發時的運行模式。TriggerType=Scheduler 時生效。 Pause：暫停 Skip：空跑 Normal：正常運行	Normal
WorkflowInstanceId	integer	所屬工作流程執行個體的 ID。	1234
WorkflowInstanceType	string	所屬工作流程執行個體的類型。 SmokeTest：測試 SupplementData：補資料 Manual：手動任務 ManualWorkflow：手動工作流程 Normal：周期調度 ManualFlow：手動執行的商務程序	Normal
UnifiedWorkflowInstanceId	integer	統一工作流程執行個體 Id，某次觸發下某業務日期內的所有任務執行個體的該欄位值相等。	1234
Timeout	integer	任務執行逾時時間，單位為秒。注意：調度系統會對任務的設定值按小時取整。	3600
RerunMode	string	任務是否允許重跑的配置。 AllDenied：失敗或成功都不可重跑 AllAllowed：失敗或成功均可重跑 FailureAllowed：只有失敗可重跑	AllAllowed
RunNumber	integer	當前啟動並執行次數，預設從 1 開始。	1
PeriodNumber	integer	周期序號。表示任務執行個體處於當天的第幾輪周期。	1
BaselineId	integer	基準 ID。	1234
Priority	integer	任務運行優先順序，最小值 1，最大值 8。取值越大，優先順序越高。預設優先順序為 1。	1
Script	object	運行指令碼資訊。
Content	string	指令碼內容。	echo "helloWorld"
Parameters	string	指令碼參數列表。	para1=$bizdate
RuntimeResource	object	執行個體關聯資源群組資訊。
ResourceGroupId	string	任務回合組態的調度資源群組標識符。	S_res_group_524258031846018_1684XXXXXXXXX
Image	string	任務回合組態的鏡像 ID。	i-xxxxxx
Cu	string	任務回合組態 CU 消耗。	0.25
Runtime	object	執行個體運行時資訊。
ProcessId	string	運行唯一 ID。	T3_123
Gateway	string	運行機器。	cn-shanghai.1.2
DataSource	object	執行個體關聯資料來源資訊。
Name	string	資料來源名稱。	mysql_test
Inputs	object	輸入資訊。
Variables	array<object>	變數定義列表。
	object
Name	string	變數名稱。	Key1
Type	string	類型。 Constant：常量 PassThrough：參數節點輸出 System：變數 NodeOutput：指令碼輸出	Constant
Value	string	變數值。	Value1
Outputs	object	輸出資訊。
TaskOutputs	array<object>	任務輸出定義列表。
	object
Output	string	輸出標識符。	pre.odps_sql_demo_0
Variables	array<object>	變數定義列表。
	object
Name	string	變數名稱。	key1
Type	string	類型。 Constant：常量 PassThrough：參數節點輸出 System：變數 NodeOutput：指令碼輸出	Constant
Value	string	變數值。	value1
Tags	array<object>	任務標籤列表。
	object
Key	string	標籤鍵。	key1
Value	string	標籤值。	value1
Status	string	執行個體運行狀態。 NotRun：未運行 Running：運行中 WaitTime：等待 TriggerTime 到來 CheckingCondition：分支條件校檢 WaitResource：等待資源 Failure：執行失敗 Success：執行成功 Checking：下發給資料品質校檢 WaitTrigger（等待外部觸發，觸發式節點會在等待時間後變成等待觸發）	Success
TriggerTime	integer	定時觸發時間。	1710239005403
Bizdate	integer	業務日期。	1710239005403
StartedTime	integer	開始已耗用時間。	1710239005403
FinishedTime	integer	完成時間。	1710239005403
Id	integer	任務執行個體的唯一識別碼。	1234
ProjectId	integer	專案 ID。	100
ProjectEnv	string	專案環境。 Prod：生產 Dev：開發	Prod
Owner	string	任務的責任人的帳號 ID。	1000
CreateTime	integer	建立時間。	1710239005403
ModifyTime	integer	修改時間。	1710239005403
CreateUser	string	建立使用者的帳號 ID。	1000
ModifyUser	string	修改使用者的帳號 ID。	1000
WaitingResourceTime	integer	進入等資源的時刻。	1710239005403
WaitingTriggerTime	integer	進入等定時時間的時刻。	1710239005403

樣本

正常返回樣本

JSON格式

{
  "RequestId": "22C97E95-F023-56B5-8852-B1A77****",
  "TaskInstance": {
    "TaskId": 1234,
    "TaskType": "ODPS_SQL",
    "TaskName": "SQL node\n",
    "Description": "test",
    "WorkflowId": 1234,
    "WorkflowName": "Test workflow",
    "TriggerType": "Scheduler",
    "TriggerRecurrence": "Normal",
    "WorkflowInstanceId": 1234,
    "WorkflowInstanceType": "Normal",
    "UnifiedWorkflowInstanceId": 1234,
    "Timeout": 3600,
    "RerunMode": "AllAllowed",
    "RunNumber": 1,
    "PeriodNumber": 1,
    "BaselineId": 1234,
    "Priority": 1,
    "Script": {
      "Content": "echo \"helloWorld\"",
      "Parameters": "para1=$bizdate"
    },
    "RuntimeResource": {
      "ResourceGroupId": "S_res_group_524258031846018_1684XXXXXXXXX",
      "Image": "i-xxxxxx",
      "Cu": "0.25"
    },
    "Runtime": {
      "ProcessId": "T3_123",
      "Gateway": "cn-shanghai.1.2"
    },
    "DataSource": {
      "Name": "mysql_test"
    },
    "Inputs": {
      "Variables": [
        {
          "Name": "Key1",
          "Type": "Constant",
          "Value": "Value1"
        }
      ]
    },
    "Outputs": {
      "TaskOutputs": [
        {
          "Output": "pre.odps_sql_demo_0"
        }
      ],
      "Variables": [
        {
          "Name": "key1",
          "Type": "Constant",
          "Value": "value1"
        }
      ]
    },
    "Tags": [
      {
        "Key": "key1",
        "Value": "value1"
      }
    ],
    "Status": "Success",
    "TriggerTime": 1710239005403,
    "Bizdate": 1710239005403,
    "StartedTime": 1710239005403,
    "FinishedTime": 1710239005403,
    "Id": 1234,
    "ProjectId": 100,
    "ProjectEnv": "Prod",
    "Owner": "1000",
    "CreateTime": 1710239005403,
    "ModifyTime": 1710239005403,
    "CreateUser": "1000",
    "ModifyUser": "1000",
    "WaitingResourceTime": 1710239005403,
    "WaitingTriggerTime": 1710239005403
  }
}

錯誤碼

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

變更歷史

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