调用ListTaskFlowsByPage接口,获取任务流运行记录列表。

调试

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

请求参数

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

系统规定参数。取值:ListTaskFlowsByPage。

Tid Long 否 3***

租户ID。

说明 取自系统右上角头像处悬停展示的租户ID信息,详情请参见查看租户信息。
PageIndex Integer 否 1

第几页。

PageSize Integer 否 20

每页数据量。

SearchKey String 否 测试节点

搜索任务流名称关键字。

返回数据

名称 类型 示例值 描述
RequestId String 6CB28697-BFE2-5739-9228-3971990E982C

请求ID。

ErrorCode String UnknownError

错误码。

ErrorMessage String UnknownError

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

Success Boolean true

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

  • true:请求成功。
  • false:请求失败。
TaskFlowList Array of TaskFlow

任务流信息列表。

TaskFlow
Id Long 7***

任务流ID。

DagName String poc_task_test

任务流名称。

Description String test

任务流描述。

CreatorId String 51****

创建人的用户ID。

CreatorNickName String Creator_NickName

创建任务流用户的昵称。

DagOwnerNickName String Owner_NickName

任务流Owner的昵称。

DeployId Long 65***

最近一次部署记录的ID。

Status Integer 1

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

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

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

  • 0:无效。
  • 1:无调度配置。
  • 2:等待调度。
LatestInstanceTime String 2022-04-13

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

TotalCount Integer 24

记录总数。

示例

请求示例

http(s)://dms-enterprise.aliyuncs.com/?Action=ListTaskFlowsByPage
&PageIndex=1
&PageSize=20
&SearchKey=测试节点
&公共请求参数

正常返回示例

XML格式

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

<ListTaskFlowsByPageResponse>
    <RequestId>6CB28697-BFE2-5739-9228-3971990E982C</RequestId>
    <Success>true</Success>
    <TaskFlowList>
        <DagName>poc_task_test</DagName>
        <Description>test</Description>
        <CreatorId>51****</CreatorId>
        <CreatorNickName>Creator_NickName</CreatorNickName>
        <DagOwnerNickName>Owner_NickName</DagOwnerNickName>
        <Status>1</Status>
        <LatestInstanceStatus>0</LatestInstanceStatus>
        <LatestInstanceTime>2022-04-13</LatestInstanceTime>
    </TaskFlowList>
    <TotalCount>24</TotalCount>
</ListTaskFlowsByPageResponse>

JSON格式

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

{
  "RequestId" : "6CB28697-BFE2-5739-9228-3971990E982C",
  "Success" : true,
  "TaskFlowList" : [ {
    "DagName" : "poc_task_test",
    "Description" : "test",
    "CreatorId" : "51****",
    "CreatorNickName" : "Creator_NickName",
    "DagOwnerNickName" : "Owner_NickName",
    "Status" : 1,
    "LatestInstanceStatus" : 0,
    "LatestInstanceTime" : "2022-04-13"
  } ],
  "TotalCount" : 24
}

错误码

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