使用ListTaskInstances擷取任務執行個體列表-巨量資料開發治理平台 DataWorks-阿里雲

分頁擷取任務執行個體列表，也可以通過條件進行篩選查詢。

介面說明

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

調試

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

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

dataworks:ListTaskInstances

get

*TaskInstance

acs:dataworks:{#regionId}:{#accountId}:taskinstance/*

無

請求參數

名稱	類型	必填	描述	樣本值
ProjectId	integer	是	專案 ID。	100
Bizdate	integer	是	業務日期。一般是周期執行個體定時時間的前一天的 0 點 0 分 0 秒，格式為毫秒級時間戳記，如 1743350400000。	1710239005403
TaskId	integer	否	對應任務的 ID。	1234
TaskIds	array	否	對應任務的 ID 列表，可根據任務 Id 批量查詢任務執行個體。
	integer	否	任務 ID。	1234
TaskName	string	否	對應任務的名稱，支援模糊查詢。	SQL node
Owner	string	否	任務的責任人的帳號 ID。	1000
TaskType	string	否	任務類型。各節點的 TaskType 取值，請參見 DataWorks 節點合集。	ODPS_SQL
RuntimeResource	string	否	資源群組資訊，這裡請填入調度資源群組標識符。	S_res_group_524258031846018_1684XXXXXXXXX
WorkflowId	integer	否	所屬工作流程的 ID。	1234
UnifiedWorkflowInstanceId	integer	否	統一工作流程執行個體 Id，某次觸發下某業務日期內的所有任務執行個體的該欄位值相等。	1234
WorkflowInstanceType	string	否	所屬工作流程執行個體的類型。 SmokeTest：測試 Manual：手動任務 SupplementData：補資料 ManualWorkflow：手動工作流程 Normal：周期調度 TriggerWorkflow：觸發式工作流程	Normal
WorkflowInstanceId	integer	否	所屬工作流程執行個體的 ID。	1234
ProjectEnv	string	否	專案環境。 Prod：生產 Dev：開發	Prod
Id	integer	否	任務執行個體 ID。任務執行個體存在重跑的情況，假如設定該參數，則返回包含重跑的歷史資訊，通過 RunNumber 區分每個歷史資訊。	1234
Ids	array	否	任務執行個體 ID 列表，可根據任務執行個體 Id 批量查詢多個任務執行個體資訊。
	integer	否	任務執行個體 ID。	1234
TriggerType	string	否	觸發方式類型。 Scheduler：周期調度觸發 Manual：手動觸發	Normal
TriggerRecurrence	string	否	觸發時的運行模式，TriggerType=Scheduler 時生效。 Pause：暫停 Skip：空跑 Normal：正常運行	Normal
SortBy	string	否	排序欄位。支援定時時間、開始時間等欄位，格式為"排序欄位+排序方式(Desc/Asc)"（Asc 可以預設）。排序欄位的枚舉值如下： `TriggerTime (Desc/Asc)` `StartedTime (Desc/Asc)` `FinishedTime (Desc/Asc)` `CreateTime (Desc/Asc)` `Id (Desc/Asc)` 預設值：`Id Desc`	Id Desc
PageSize	integer	否	每頁的條目數，預設為 10，最大為 500。	10
PageNumber	integer	否	頁碼，從 1 開始，預設為 1。	1
Status	string	否	任務執行個體的狀態： `NotRun`：未運行 `Running`：運行中 `Failure`：運行失敗 `Success`：運行成功 `WaitTime`：等待時間 `WaitResource`：等待資源	Success
Filter	string	否	過濾器。JSON 格式，多個過濾條件之間是"且"的關係。目前支援的欄位有：`startedTimeStart, startedTimeEnd, finishedTimeStart, finishedTimeEnd, createTimeStart, createTimeEnd`	{ "startedTimeStart": "1763481600000", "startedTimeEnd": "1763481600000", "finishedTimeStart": "1763481600000", "finishedTimeEnd": "1763481600000", "createTimeStart": "1763481600000", "createTimeEnd": "1763481600000" }

返回參數

名稱	類型	描述	樣本值
	object
RequestId	string	請求的 ID，用於定位日誌，排查問題。	22C97E95-F023-56B5-8852-B1A77A17XXXX
PagingInfo	object	分頁資訊。
TaskInstances	array<object>	任務執行個體列表。
	array<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	觸發方式類型。 Scheduler：調度周期觸發 Manual：手動觸發	Scheduler
TriggerRecurrence	string	觸發時的運行模式。TriggerType=Scheduler 時生效。 Pause：暫停 Skip：空跑 Normal：正常運行	Normal
WorkflowInstanceId	integer	所屬工作流程執行個體的 ID。	1234
UnifiedWorkflowInstanceId	integer	統一工作流程執行個體 Id，某次觸發下某業務日期內的所有任務執行個體的該欄位值相等。	1234
WorkflowInstanceType	string	所屬工作流程執行個體的類型。 SmokeTest：測試 SupplementData：補資料 Manual：手動 ManualWorkflow：手動工作流程 Normal：周期調度 ManualFlow：手動執行的商務程序	Normal
Timeout	integer	任務執行逾時時間，單位為秒。注意：調度系統會對任務的設定值按小時取整。	3600
RerunMode	string	任務是否允許重跑的配置。 AllDenied：失敗或成功都不可重跑 FailureAllowed：只有失敗可重跑 AllAllowed：失敗或成功均可重跑	AllAllowed
RunNumber	integer	當前啟動並執行次數，預設從 1 開始。	1
PeriodNumber	integer	周期序號。表示任務執行個體處於當天的第幾輪周期。	1
BaselineId	integer	基準 ID。	1234
Priority	integer	任務運行優先順序，最小值 1，最大值 8。取值越大，優先順序越高。預設優先順序為 1。	1
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
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
ScriptParameters	string	指令碼參數列表。	para1=val1 para2=val2
WaitingResourceTime	integer	進入等資源的時刻。	1710239005403
WaitingTriggerTime	integer	進入等定時時間的時刻。	1710239005403
TotalCount	integer	資料總條數。	100
PageSize	integer	每頁的條目數。	10
PageNumber	integer	頁碼。	1

樣本

正常返回樣本

JSON格式

{
  "RequestId": "22C97E95-F023-56B5-8852-B1A77A17XXXX",
  "PagingInfo": {
    "TaskInstances": [
      {
        "TaskId": 1234,
        "TaskType": "ODPS_SQL\n",
        "TaskName": "SQL node\n",
        "Description": "test\n",
        "WorkflowId": 1234,
        "WorkflowName": "Test workflow\n",
        "TriggerType": "Scheduler\n",
        "TriggerRecurrence": "Normal\n",
        "WorkflowInstanceId": 1234,
        "UnifiedWorkflowInstanceId": 1234,
        "WorkflowInstanceType": "Normal",
        "Timeout": 3600,
        "RerunMode": "AllAllowed\n",
        "RunNumber": 1,
        "PeriodNumber": 1,
        "BaselineId": 1234,
        "Priority": 1,
        "RuntimeResource": {
          "ResourceGroupId": "S_res_group_524258031846018_1684XXXXXXXXX",
          "Image": "i-xxxxxx\n",
          "Cu": "0.25\n"
        },
        "Runtime": {
          "ProcessId": "T3_123\n",
          "Gateway": "cn-shanghai.1.2\n"
        },
        "DataSource": {
          "Name": "mysql_test\n"
        },
        "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",
        "ScriptParameters": "para1=val1 para2=val2",
        "WaitingResourceTime": 1710239005403,
        "WaitingTriggerTime": 1710239005403
      }
    ],
    "TotalCount": 100,
    "PageSize": 10,
    "PageNumber": 1
  }
}

錯誤碼

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

變更歷史

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