调用ListTaskFlowInstance获取任务流运行记录_数据管理（兼容数据库备份）(DMS)-阿里云帮助中心

调用ListTaskFlowInstance接口，获取任务流运行记录。

调试

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

授权信息

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

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

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

请求参数

名称	类型	必填	描述	示例值
DagId	long	是	任务流 ID，可通过调用接口 ListTaskFlow 或 ListLhTaskFlowAndScenario 获取该参数的值。	7***
TriggerType	integer	否	触发类型，取值如下： 0：周期调度 1：手动运行	1
StartTimeBegin	string	否	筛选出指定时间之后开始的任务流运行记录。时间格式为 yyyy-MM-DD。	2022-01-07
StartTimeEnd	string	否	筛选出指定时间之前开始的任务流运行记录。时间格式为 yyyy-MM-DD。	2022-04-08
PageIndex	integer	是	第几页。	1
PageSize	integer	是	每页数据量。	20
Tid	long	否	租户 ID。您可以调用 GetUserActiveTenant 或 ListUserTenants 接口获取该参数。	3***
UseBizDate	boolean	否	调整筛选条件： true: StartTimeBegin 和 StartTimeEnd 为筛选业务时间区间范围。 false: StartTimeBegin 和 StartTimeEnd 为任务运行时间区间范围。	true
Status	integer	否	任务节点运行状态，取值如下： 0：等待调度 1：正在运行 2：挂起 3：运行失败 4：运行成功 5：已完成	3

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求 ID。	8CFF2295-8249-5287-B888-DBD4F0D76CB0
ErrorCode	string	错误码。	UnknownError
ErrorMessage	string	错误信息。	UnknownError
Success	boolean	请求是否成功，返回值如下： true：请求成功 false：请求失败	true
DAGInstanceList	array<object>	任务流运行记录列表。
DAGInstance	object	任务流运行记录列表。
Id	long	运行记录 ID。	9234
BusinessTime	string	任务流业务时间，时间格式为 yyyy-MM-DD HH:mm:ss。	2021-11-10 14:37:26
startTime	string	任务流运行开始时间，时间格式为 yyyy-MM-DD HH:mm:ss。	2021-11-11 14:35:57
EndTime	string	任务流运行结束时间，时间格式为 yyyy-MM-DD HH:mm:ss。	2021-11-11 14:38:57
DagId	string	任务流 ID。	7***
TriggerType	integer	触发类型。返回值如下： 0：周期调度 1：手动运行	1
Status	integer	任务流状态，返回值如下： 0：等待调度 1：运行中 2：暂停 3：失败 4：成功 5：完成	4
Message	string	任务描述信息。	test
HistoryDagId	long	历史任务流版本 ID。	2****
DagName	string	任务流名称。	Spark_SQL_test
OwnerName	string	任务流 Owner 的名称。	test_name
DagVersion	string	任务流版本。	[]
TotalCount	integer	满足条件运行记录总个数。	1

示例

正常返回示例

JSON格式

{
  "RequestId": "8CFF2295-8249-5287-B888-DBD4F0D76CB0",
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "Success": true,
  "DAGInstanceList": {
    "DAGInstance": [
      {
        "Id": 9234,
        "BusinessTime": "2021-11-10 14:37:26",
        "startTime": "2021-11-11 14:35:57\n",
        "EndTime": "2021-11-11 14:38:57",
        "DagId": "7***",
        "TriggerType": 1,
        "Status": 4,
        "Message": "test",
        "HistoryDagId": 0,
        "DagName": "Spark_SQL_test",
        "OwnerName": "test_name",
        "DagVersion": "[]"
      }
    ]
  },
  "TotalCount": 1
}

错误码

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

变更历史

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