调用ListTaskFlowsByPage接口，分页获取任务流详情列表。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
dms:ListTaskFlowsByPage |
list |
*全部资源
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| Tid |
integer |
否 |
租户 ID。 说明
取自系统右上角头像处悬停展示的租户 ID 信息，详情请参见查看租户信息。 |
3*** |
| ScenarioId |
integer |
否 |
过滤条件，应用场景 ID |
12*** |
| DagIdList |
array |
否 |
过滤条件，任务流 ID 列表。 |
|
|
integer |
否 |
过滤条件，任务流 ID。 |
4512 |
|
| SearchKey |
string |
否 |
搜索任务流名称关键字。 |
测试节点 |
| PageIndex |
integer |
否 |
第几页。 |
1 |
| PageSize |
integer |
否 |
每页数据量。 |
20 |
过滤条件之间的关系为 AND。
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| RequestId |
string |
请求 ID。 |
6CB28697-BFE2-5739-9228-3971990E982C |
| ErrorCode |
string |
错误码。 |
UnknownError |
| ErrorMessage |
string |
调用失败时，返回的错误信息。 |
UnknownError |
| Success |
boolean |
请求是否成功，返回值如下：
|
true |
| TaskFlowList |
object |
||
| TaskFlow |
array<object> |
任务流信息列表。 |
|
|
object |
|||
| Id |
integer |
任务流 ID。 |
7*** |
| DagName |
string |
任务流名称。 |
poc_task_test |
| Description |
string |
任务流描述。 |
test |
| CreatorId |
string |
创建人的用户 ID。 |
51**** |
| CreatorNickName |
string |
创建任务流用户的昵称。 |
Creator_NickName |
| DagOwnerNickName |
string |
任务流 Owner 的昵称。 |
Owner_NickName |
| DeployId |
integer |
最近一次部署记录的 ID。 |
65*** |
| Status |
integer |
任务流状态，返回值如下：
|
1 |
| LatestInstanceStatus |
integer |
最后一个运行记录的状态，返回值如下：
|
0 |
| LatestInstanceTime |
string |
最近一个运行记录的创建时间。 |
2022-04-13 |
| ScenarioId |
string |
应用场景 ID。 |
1245 |
| CronSwitch |
boolean |
是否开启定时调度。 |
false |
| CronStr |
string |
定时调度 Cron。 |
0 0 1 * * ? * |
| ScheduleParam |
string |
事件调度配置，JSON 字符串格式。 |
{\"triggerType\":\"1\",\"specificTime\":'2022-11-15 11:59'} |
| TriggerType |
integer |
触发类型。返回值如下：
|
0 |
| CronType |
integer |
调度周期类型。取值如下：
|
2 |
| CronBeginDate |
string |
定时调度开始时间，此时间点之前任务流不进行调度。 |
1970-01-01 |
| CronEndDate |
string |
定时调度结束时间，此时间点之后任务流不进行调度。 |
2023-01-01 |
| TimeZoneId |
string |
时区设置，默认为东八区（Asia/Shanghai）。 |
Asia/Shanghai |
| DagOwnerId |
string |
任务流负责人的用户 ID。 |
12***89 |
| TotalCount |
integer |
记录总数。 |
24 |
示例
正常返回示例
JSON格式
{
"RequestId": "6CB28697-BFE2-5739-9228-3971990E982C",
"ErrorCode": "UnknownError",
"ErrorMessage": "UnknownError",
"Success": true,
"TaskFlowList": {
"TaskFlow": [
{
"Id": 0,
"DagName": "poc_task_test",
"Description": "test",
"CreatorId": "51****",
"CreatorNickName": "Creator_NickName",
"DagOwnerNickName": "Owner_NickName",
"DeployId": 0,
"Status": 1,
"LatestInstanceStatus": 0,
"LatestInstanceTime": "2022-04-13",
"ScenarioId": "1245",
"CronSwitch": false,
"CronStr": "0 0 1 * * ? *",
"ScheduleParam": "{\\\"triggerType\\\":\\\"1\\\",\\\"specificTime\\\":'2022-11-15 11:59'}",
"TriggerType": 0,
"CronType": 2,
"CronBeginDate": "1970-01-01",
"CronEndDate": "2023-01-01",
"TimeZoneId": "Asia/Shanghai",
"DagOwnerId": "12***89"
}
]
},
"TotalCount": 24
}错误码
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。