ListTaskFlowsByPage - 分页获取任务流详情列表 - 数据管理 DMS

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

调试

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

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
dms:ListTaskFlowsByPage	List	全部资源 *	无	无

请求参数

名称	类型	必填	描述	示例值
Tid	long	否	租户 ID。说明取自系统右上角头像处悬停展示的租户 ID 信息，详情请参见查看租户信息。	3***
ScenarioId	long	否	过滤条件，应用场景 ID	12***
DagIdList	array	否	过滤条件，任务流 ID 列表。
	long	否	过滤条件，任务流 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：请求成功。 false：请求失败。	true
TaskFlowList	object []	任务流信息列表。
Id	long	任务流 ID。	7***
DagName	string	任务流名称。	poc_task_test
Description	string	任务流描述。	test
CreatorId	string	创建人的用户 ID。	51****
CreatorNickName	string	创建任务流用户的昵称。	Creator_NickName
DagOwnerNickName	string	任务流 Owner 的昵称。	Owner_NickName
DeployId	long	最近一次部署记录的 ID。	65***
Status	integer	任务流状态，返回值如下： 0：无效。 1：无调度配置。 2：等待调度。	1
LatestInstanceStatus	integer	最后一个运行记录的状态，返回值如下： 0：无效。 1：无调度配置。 2：等待调度。	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：周期调度 1：手动运行	0
CronType	integer	调度周期类型。取值如下： 2: 小时级调度 3: 日级调度 4: 周级调度 5: 月级调度	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
}

错误码

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

变更历史

变更时间

变更内容概要

操作

2023-06-05

OpenAPI 返回结构发生变更

看变更集

变更项	变更内容
出参	OpenAPI 返回结构发生变更。

2023-05-26

OpenAPI 返回结构发生变更

看变更集

变更项	变更内容
出参	OpenAPI 返回结构发生变更。

2023-05-26

OpenAPI 返回结构发生变更

看变更集

变更项	变更内容
出参	OpenAPI 返回结构发生变更。

2023-05-25

OpenAPI 入参发生变更、OpenAPI 返回结构发生变更

看变更集

变更项	变更内容
入参	OpenAPI 入参发生变更。
	新增入参：ScenarioId
	新增入参：DagIdList
出参	OpenAPI 返回结构发生变更。