Queries task flows.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes ListTaskFlow

The operation that you want to perform. Set the value to ListTaskFlow.

Tid Long No 3***

The ID of the tenant. You can call the GetUserActiveTenant or ListUserTenants operation to obtain the tenant ID.

RegionId String No cn-hangzhou

The ID of the region in which Data Management (DMS) is activated. For more information, see RegionID parameter.

Response parameters

Parameter Type Example Description
RequestId String 4116147E-C628-5816-8779-8EEAF8E973F4

The ID of the request.

ErrorCode String 403

The error code.

ErrorMessage String UnknownError

The error message.

Success Boolean true

Indicates whether the request was successful. Valid values:

  • true: The request was successful.
  • false: The request failed.
TaskFlowList Array of TaskFlow

The information about the task flows returned.

TaskFlow
Id Long 134137****

The ID of the task flow.

CreatorId String 51****

The ID of the user who creates the task flow.

CreatorNickName String Creator_NickName

The name of the user who creates the task flow.

DagOwnerNickName String Owner_NickName

The name of the task flow owner.

DeployId Long 12**

The ID of the latest deployment record.

Status Integer 2

The status of the task flow. Valid values:

  • 0: The task flow is invalid.
  • 1: Scheduling is disabled for the task flow.
  • 2: The task flow is waiting to be scheduled.
LatestInstanceStatus Integer 0

The status of the latest execution. Valid values:

  • 0: invalid.
  • 1: scheduling disabled.
  • 2: waiting to be scheduled.
LatestInstanceTime String 2022-04-13

The time when the latest execution record was generated.

Examples

Sample request

http(s)://dms-enterprise.aliyuncs.com/?Action=ListTaskFlow
&Tid=3***
&<Common request parameters>

Sample success responses

XML format

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

<ListTaskFlowResponse>
    <RequestId>4116147E-C628-5816-8779-8EEAF8E973F4</RequestId>
    <Success>true</Success>
    <TaskFlowList>
        <CreatorId>51****</CreatorId>
        <CreatorNickName>Creator_NickName</CreatorNickName>
        <DagOwnerNickName>Owner_NickName</DagOwnerNickName>
        <Status>2</Status>
        <LatestInstanceStatus>0</LatestInstanceStatus>
        <LatestInstanceTime>2022-04-13</LatestInstanceTime>
    </TaskFlowList>
</ListTaskFlowResponse>

JSON format

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

{
  "RequestId" : "4116147E-C628-5816-8779-8EEAF8E973F4",
  "Success" : true,
  "TaskFlowList" : [ {
    "CreatorId" : "51****",
    "CreatorNickName" : "Creator_NickName",
    "DagOwnerNickName" : "Owner_NickName",
    "Status" : 2,
    "LatestInstanceStatus" : 0,
    "LatestInstanceTime" : "2022-04-13"
  } ]
}

Error codes

For a list of error codes, visit the API Error Center.