ListTaskFlowsByPage -

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	ListTaskFlowsByPage	The operation that you want to perform. Set the value to ListTaskFlowsByPage.
Tid	Long	No	3***	The ID of the tenant. Note The ID of the tenant is displayed when you move the pointer over the profile picture in the upper-right corner of the DMS console. For more information, see the View information about the current tenant section of the Manage DMS tenants topic.
PageIndex	Integer	No	1	The number of the page to return.
PageSize	Integer	No	20	The number of entries to return on each page.
SearchKey	String	No	Test node	The keyword that is used to search for the task flow.

Response parameters


Parameter	Type	Example	Description
RequestId	String	6CB28697-BFE2-5739-9228-3971990E982C	The ID of the request.
ErrorCode	String	UnknownError	The error code returned if the request failed.
ErrorMessage	String	UnknownError	The error message returned if the request failed.
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	7***	The ID of the task flow.
DagName	String	poc_task_test	The name of the task flow.
Description	String	test	The description of the task flow.
CreatorId	String	51****	The ID of the user who created the task flow.
CreatorNickName	String	Creator_NickName	The nickname of the user who created the task flow.
DagOwnerNickName	String	Owner_NickName	The nickname of the task flow owner.
DeployId	Long	65***	The ID of the latest deployment record.
Status	Integer	1	The status of the task flow. Valid values: 0: invalid 1: scheduling disabled 2: 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.
TotalCount	Integer	24	The total number of entries that are returned.

Examples

Sample requests

http(s)://dms-enterprise.aliyuncs.com/?Action=ListTaskFlowsByPage
&PageIndex=1
&PageSize=20
&SearchKey=Test node
&Common request parameters

Sample success responses

XML format

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 format

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
}

Error codes

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