ListWorkflowInstances - 擷取工作流程執行個體列表
分頁擷取工作流程執行個體列表，也可以通過條件進行篩選查詢。
介面說明
需要購買 DataWorks 基礎版及以上版本才能使用。
調試
您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
dataworks:* |
get |
*全部資源
|
無 | 無 |
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| ProjectId |
integer |
是 |
專案 ID。 |
100 |
| BizDate |
integer |
是 |
業務日期。一般是周期執行個體定時時間的前一天的 0 點 0 分 0 秒，格式為毫秒級時間戳記，如 1743350400000。 |
1710239005403 |
| Type |
string |
否 |
工作流程執行個體的類型。
|
Normal |
| WorkflowId |
integer |
否 |
所屬工作流程的 ID。 |
1234 |
| UnifiedWorkflowInstanceId |
integer |
否 |
統一工作流程執行個體 Id，某次觸發下某業務日期內的所有工作流程執行個體的該欄位值相等。 |
1234 |
| Name |
string |
否 |
名稱。支援模糊查詢。 |
WorkflowInstance1 |
| Ids |
array |
否 |
工作流程執行個體 ID 列表，可根據工作流程執行個體 Id 批量查詢多個工作流程執行個體資訊。 |
|
|
integer |
否 |
工作流程執行個體 ID。 |
1234 |
|
| Owner |
string |
否 |
責任人的帳號 ID。 |
1000 |
| SortBy |
string |
否 |
排序欄位列表，支援定時時間、開始時間等欄位。格式為"排序欄位+排序方式(Desc/Asc)"（Asc 可以預設）。排序欄位的枚舉值如下：
預設值：Id Desc |
Id Desc |
| PageSize |
integer |
否 |
每頁的條目數，預設為 10。 |
10 |
| PageNumber |
integer |
否 |
頁碼，從 1 開始，預設為 1。 |
1 |
| Tags |
array |
否 |
標籤列表，多個標籤中滿足一個即會返回結果。 |
|
|
string |
否 |
標籤。格式為： |
key:value |
|
| Filter |
string |
否 |
過濾器。JSON 格式，多個過濾條件之間是"且"的關係。目前支援的欄位有： |
{ "status": "Success", "executionDate": "1763481600000" } |
| EnvType |
string |
否 |
Prod |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
|||
| RequestId |
string |
請求的 ID。用於定位日誌，排查問題。 |
22C97E95-F023-56B5-8852-B1A77A17XXXX |
| PagingInfo |
object |
分頁資訊。 |
|
| WorkflowInstances |
array<object> |
工作流程執行個體列表。 |
|
|
array<object> |
|||
| Id |
integer |
工作流程執行個體的唯一識別碼。 |
1234 |
| WorkflowTaskInstanceId |
integer |
工作流程執行個體對應的任務執行個體 ID。 |
1234 |
| UnifiedWorkflowInstanceId |
integer |
統一工作流程執行個體 Id，某次觸發下某業務日期內的所有工作流程執行個體的該欄位值相等。 |
1234 |
| Name |
string |
名稱。 |
WorkflowInstance1 |
| Type |
string |
工作流程執行個體的類型。
|
Normal |
| Status |
string |
工作流程執行個體運行狀態。
|
Success |
| BizDate |
integer |
業務日期。 |
1710239005403 |
| StartedTime |
integer |
開始已耗用時間。 |
1710239005403 |
| FinishedTime |
integer |
完成時間。 |
1710239005403 |
| ProjectId |
integer |
專案 ID。 |
100 |
| EnvType |
string |
專案環境。
|
Prod |
| Owner |
string |
工作流程的責任人的帳號 ID。 |
1000 |
| CreateTime |
integer |
建立時間。 |
1710239005403 |
| ModifyTime |
integer |
修改時間。 |
1710239005403 |
| CreateUser |
string |
建立使用者的帳號 ID。 |
100 |
| ModifyUser |
string |
修改使用者的帳號 ID。 |
100 |
| WorkflowParameters |
string |
工作流程參數。 |
周期工作流程： key1=value1 key2=value2 手動商務程序： {"key1":"value1", "key2": "value2"} |
| WorkflowId |
integer |
所屬工作流程的 ID。 |
1234 |
| Tags |
array<object> |
任務標籤 |
|
|
object |
|||
| Key |
string |
標籤鍵。 |
key1 |
| Value |
string |
標籤值。 |
value1 |
| TotalCount |
integer |
資料總條數。 |
100 |
| PageSize |
integer |
每頁的條目數。 |
10 |
| PageNumber |
integer |
頁碼。 |
1 |
樣本
正常返回樣本
JSON格式
{
"RequestId": "22C97E95-F023-56B5-8852-B1A77A17XXXX",
"PagingInfo": {
"WorkflowInstances": [
{
"Id": 1234,
"WorkflowTaskInstanceId": 1234,
"UnifiedWorkflowInstanceId": 1234,
"Name": "WorkflowInstance1",
"Type": "Normal",
"Status": "Success",
"BizDate": 1710239005403,
"StartedTime": 1710239005403,
"FinishedTime": 1710239005403,
"ProjectId": 100,
"EnvType": "Prod",
"Owner": "1000",
"CreateTime": 1710239005403,
"ModifyTime": 1710239005403,
"CreateUser": "100",
"ModifyUser": "100",
"WorkflowParameters": "周期工作流程：\nkey1=value1 key2=value2\n手動商務程序：\n{\"key1\":\"value1\", \"key2\": \"value2\"}",
"WorkflowId": 1234,
"Tags": [
{
"Key": "key1",
"Value": "value1"
}
]
}
],
"TotalCount": 100,
"PageSize": 10,
"PageNumber": 1
}
}錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊，參考變更詳情。