分頁擷取工作流程列表，也可以通過條件進行篩選查詢。
介面說明
需要購買 DataWorks 基礎版及以上版本才能使用。
調試
您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| ProjectId |
integer |
是 |
專案 ID。 |
100 |
| EnvType |
string |
否 |
專案環境。
|
Prod |
| Ids |
array |
否 |
工作流程 ID 列表，可根據工作流程 Id 批量查詢多個工作流程資訊。 |
|
|
integer |
否 |
工作流程 ID。 |
1234 |
|
| Name |
string |
否 |
名稱。支援模糊查詢。 |
Workflow1 |
| Owner |
string |
否 |
責任人的帳號 ID。 |
1000 |
| TriggerType |
string |
否 |
觸發方式類型。
|
Scheduler |
| SortBy |
string |
否 |
排序欄位。支援修改時間、建立時間等欄位，格式為"排序欄位+排序方式(Desc/Asc)"（Asc 可以預設）。排序欄位的枚舉值如下：
預設值：Id Desc |
Id Desc |
| PageSize |
integer |
否 |
每頁的條目數，預設為 10。 |
10 |
| PageNumber |
integer |
否 |
頁碼，從 1 開始，預設為 1。 |
1 |
| Tags |
array |
否 |
標籤列表，多個標籤中滿足一個即會返回結果。 |
|
|
string |
否 |
標籤。格式為： |
key:value |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
|||
| RequestId |
string |
請求的 ID，用於定位日誌，排查問題。 |
22C97E95-F023-56B5-8852-B1A77A17XXXX |
| PagingInfo |
object |
分頁資訊。 |
|
| Workflows |
array<object> |
工作流程列表。 |
|
|
array<object> |
|||
| Id |
integer |
工作流程的唯一識別碼。 |
1234 |
| Name |
string |
名稱。 |
Workflow1 |
| Description |
string |
描述資訊。 |
test |
| Trigger |
object |
觸發方式。 |
|
| Type |
string |
觸發方式類型。
|
Scheduler |
| Recurrence |
string |
觸發時的運行模式，type=Scheduler 時生效。
|
Normal |
| Cron |
string |
Cron 運算式，type=Scheduler 時生效。 |
00 00 00 * * ? |
| StartTime |
string |
周期觸發生效時間，type=Scheduler 時生效。 |
1970-01-01 00:00:00 |
| EndTime |
string |
周期觸發失效時間，type=Scheduler 時生效。 |
9999-01-01 00:00:00 |
| Parameters |
string |
參數列表。 |
para1=$bizdate para2=$[yyyymmdd] |
| ClientUniqueCode |
string |
工作流程的用戶端唯一碼，用於實現非同步和等冪。建立時如果不指定，系統將自動產生，該代碼將與資源 ID 進行唯一綁定。更新、刪除資源時如果指定該參數，應與建立時的用戶端唯一碼保持統一。 |
Workflow_0bc5213917368545132902xxxxxxxx |
| ProjectId |
integer |
專案 ID。 |
100 |
| EnvType |
string |
專案環境。
|
Prod |
| Owner |
string |
責任人的帳號 ID。 |
1000 |
| CreateTime |
integer |
建立時間。 |
1710239005403 |
| ModifyTime |
integer |
修改時間。 |
1710239005403 |
| CreateUser |
string |
建立使用者的帳號 ID。 |
1000 |
| ModifyUser |
string |
修改使用者的帳號 ID。 |
1000 |
| 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": {
"Workflows": [
{
"Id": 1234,
"Name": "Workflow1",
"Description": "test",
"Trigger": {
"Type": "Scheduler",
"Recurrence": "Normal",
"Cron": "00 00 00 * * ?",
"StartTime": "1970-01-01 00:00:00",
"EndTime": "9999-01-01 00:00:00"
},
"Parameters": "para1=$bizdate para2=$[yyyymmdd] ",
"ClientUniqueCode": "Workflow_0bc5213917368545132902xxxxxxxx",
"ProjectId": 100,
"EnvType": "Prod",
"Owner": "1000",
"CreateTime": 1710239005403,
"ModifyTime": 1710239005403,
"CreateUser": "1000",
"ModifyUser": "1000",
"Tags": [
{
"Key": "key1",
"Value": "value1"
}
]
}
],
"TotalCount": 100,
"PageSize": 10,
"PageNumber": 1
}
}錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊，參考變更詳情。