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

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 ListTaskFlowInstance

系统规定参数。取值：ListTaskFlowInstance。

DagId Long 是 7***

任务流ID，可通过调用接口ListTaskFlow或ListLhTaskFlowAndScenario获取该参数的值。

TriggerType Integer 否 1

触发类型，取值如下：

  • 0：周期调度
  • 1：手动运行
StartTimeBegin String 否 2022-01-07

筛选出指定时间之后开始的任务流运行记录。时间格式为yyyy-MM-DD。
StartTimeEnd String 否 2022-04-08

筛选出指定时间之前开始的任务流运行记录。时间格式为yyyy-MM-DD。
PageIndex Integer 是 1

第几页。
PageSize Integer 是 20

每页数据量。
Tid Long 否 3***

租户ID。您可以调用GetUserActiveTenant或ListUserTenants接口获取该参数。

返回数据

名称 类型 示例值 描述
RequestId String 8CFF2295-8249-5287-B888-DBD4F0D76CB0

请求ID。
ErrorCode String UnknownError

错误码。
ErrorMessage String UnknownError

错误信息。
Success Boolean true

请求是否成功，返回值如下：

  • true：请求成功
  • false：请求失败
DAGInstanceList Array of DAGInstance

任务流运行记录列表。
DAGInstance
Id Long 9234

运行记录ID。
BusinessTime String 2021-11-10 14:37:26

任务流业务时间，时间格式为yyyy-MM-DD HH:mm:ss。
EndTime String 2021-11-11 14:38:57

任务流运行结束时间，时间格式为yyyy-MM-DD HH:mm:ss。
DagId String 7***

任务流ID。
TriggerType Integer 1

触发类型。返回值如下：

  • 0：周期调度
  • 1：手动运行
Status Integer 4

任务流状态，返回值如下：

  • 0：等待调度
  • 1：运行中
  • 2：暂停
  • 3：失败
  • 4：成功
  • 5：完成
Message String test

任务描述信息。
HistoryDagId Long 2****

历史任务流版本ID。
DagName String Spark_SQL_test

任务流名称。
OwnerName String test_name

任务流Owner的名称。
DagVersion String []

任务流版本。
TotalCount Integer 1

满足条件运行记录总个数。

示例

请求示例

http(s)://dms-enterprise.aliyuncs.com/?Action=ListTaskFlowInstance
&DagId=7***
&TriggerType=1
&StartTimeBegin=2022-01-07
&StartTimeEnd=2022-04-08
&PageIndex=1
&PageSize=20
&Tid=3***
&公共请求参数

正常返回示例

XML格式 

HTTP/1.1 200 OK
Content-Type:application/xml

<ListTaskFlowInstanceResponse>
    <RequestId>8CFF2295-8249-5287-B888-DBD4F0D76CB0</RequestId>
    <Success>true</Success>
    <DAGInstanceList>
        <Id>9234</Id>
        <BusinessTime>2021-11-10 14:37:26</BusinessTime>
        <EndTime>2021-11-11 14:38:57</EndTime>
        <DagId>7***</DagId>
        <TriggerType>1</TriggerType>
        <Status>4</Status>
        <Message>test</Message>
        <DagName>Spark_SQL_test</DagName>
        <OwnerName>test_name</OwnerName>
    </DAGInstanceList>
    <TotalCount>1</TotalCount>
</ListTaskFlowInstanceResponse>

JSON格式 

HTTP/1.1 200 OK
Content-Type:application/json

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

错误码

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