ListTaskFlowsByPage - 分页获取任务流详情列表

调用ListTaskFlowsByPage接口,分页获取任务流详情列表。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
dms:ListTaskFlowsByPagelist
  • 全部资源
    *

请求参数

名称类型必填描述示例值
Tidlong

租户 ID。

说明 取自系统右上角头像处悬停展示的租户 ID 信息,详情请参见查看租户信息
3***
ScenarioIdlong

过滤条件,应用场景 ID

12***
DagIdListarray

过滤条件,任务流 ID 列表。

long

过滤条件,任务流 ID。

4512
SearchKeystring

搜索任务流名称关键字。

测试节点
PageIndexinteger

第几页。

1
PageSizeinteger

每页数据量。

20

过滤条件之间的关系为 AND。

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

6CB28697-BFE2-5739-9228-3971990E982C
ErrorCodestring

错误码。

UnknownError
ErrorMessagestring

调用失败时,返回的错误信息。

UnknownError
Successboolean

请求是否成功,返回值如下:

  • true:请求成功。
  • false:请求失败。
true
TaskFlowListarray<object>

任务流信息列表。

TaskFlowobject
Idlong

任务流 ID。

7***
DagNamestring

任务流名称。

poc_task_test
Descriptionstring

任务流描述。

test
CreatorIdstring

创建人的用户 ID。

51****
CreatorNickNamestring

创建任务流用户的昵称。

Creator_NickName
DagOwnerNickNamestring

任务流 Owner 的昵称。

Owner_NickName
DeployIdlong

最近一次部署记录的 ID。

65***
Statusinteger

任务流状态,返回值如下:

  • 0:无效。
  • 1:无调度配置。
  • 2:等待调度。
1
LatestInstanceStatusinteger

最后一个运行记录的状态,返回值如下:

  • 0:无效。
  • 1:无调度配置。
  • 2:等待调度。
0
LatestInstanceTimestring

最近一个运行记录的创建时间。

2022-04-13
ScenarioIdstring

应用场景 ID。

1245
CronSwitchboolean

是否开启定时调度。

false
CronStrstring

定时调度 Cron。

0 0 1 * * ? *
ScheduleParamstring

事件调度配置,JSON 字符串格式。

{\"triggerType\":\"1\",\"specificTime\":'2022-11-15 11:59'}
TriggerTypeinteger

触发类型。返回值如下:

  • 0:周期调度
  • 1:手动运行
0
CronTypeinteger

调度周期类型。取值如下:

  • 2: 小时级调度
  • 3: 日级调度
  • 4: 周级调度
  • 5: 月级调度
2
CronBeginDatestring

定时调度开始时间,此时间点之前任务流不进行调度。

1970-01-01
CronEndDatestring

定时调度结束时间,此时间点之后任务流不进行调度。

2023-01-01
TimeZoneIdstring

时区设置,默认为东八区(Asia/Shanghai)。

Asia/Shanghai
DagOwnerIdstring

任务流负责人的用户 ID。

12***89
TotalCountinteger

记录总数。

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
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2023-06-05OpenAPI 返回结构发生变更查看变更详情
2023-05-26OpenAPI 返回结构发生变更查看变更详情
2023-05-26OpenAPI 返回结构发生变更查看变更详情
2023-05-25OpenAPI 入参发生变更、OpenAPI 返回结构发生变更查看变更详情