Call ListTaskFlowInstance to query task flow execution records - Data Management - Alibaba Cloud - Data Management

Queries the execution records of a task flow.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

dms:ListTaskFlowInstance

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
DagId	integer	Yes	The ID of the task flow. You can call the ListTaskFlow or ListLhTaskFlowAndScenario operation to obtain the task flow ID.	7***
TriggerType	integer	No	The mode in which the task flow is triggered. Valid values: 0: The task flow is automatically triggered based on periodic scheduling. 1: The task flow is manually triggered.	1
StartTimeBegin	string	No	The start of the time range for querying execution records. Specify the time in the yyyy-MM-DD format.	2022-01-07
StartTimeEnd	string	No	The end of the time range for querying execution records. Specify the time in the yyyy-MM-DD format.	2022-04-08
PageIndex	integer	Yes	The number of the page to return.	1
PageSize	integer	Yes	The number of entries to return on each page.	20
Tid	integer	No	The ID of the tenant. You can call the GetUserActiveTenant or ListUserTenants operation to obtain the tenant ID.	3***
UseBizDate	boolean	No	Specifies the type of time range to filter by: true: StartTimeBegin and StartTimeEnd specify the business time range. false: StartTimeBegin and StartTimeEnd specify the task execution time range.	true
Status	integer	No	The running status of the task node. Valid values: 0: Waiting for scheduling 1: Running 2: Suspend 3: Failed to run 4: Run successfully 5: Completed	2

Response elements

Element	Type	Description	Example
	object
RequestId	string	The ID of the request.	8CFF2295-8249-5287-B888-DBD4F0D76CB0
ErrorCode	string	The error code returned if the request fails.	UnknownError
ErrorMessage	string	The error message returned if the request fails.	UnknownError
Success	boolean	Indicates whether the request is successful. Valid values: true: The request is successful. false: The request fails.	true
DAGInstanceList	object
DAGInstance	array<object>	The execution records.
	object
Id	integer	The ID of the execution record.	9234
BusinessTime	string	The business time of the task flow, in the yyyy-MM-DD HH:mm:ss format.	2021-11-10 14:37:26
startTime	string	The time when the task flow started, in the yyyy-MM-DD HH:mm:ss format.	2021-11-11 14:35:57
EndTime	string	The time when the task flow completed, in the yyyy-MM-DD HH:mm:ss format.	2021-11-11 14:38:57
DagId	string	The ID of the task flow.	7***
TriggerType	integer	The mode in which the task flow is triggered. Valid values: 0: The task flow is automatically triggered based on periodic scheduling. 1: The task flow is manually triggered.	1
Status	integer	The status of the task flow. Valid values: 0: The task flow is waiting to be scheduled. 1: The task flow is being executed. 2: The task flow is paused. 3: The task flow failed. 4: The task flow is executed. 5: The task flow is complete.	4
Message	string	The description of the task.	test
HistoryDagId	integer	The ID of the previously published version of the task flow.	2****
DagName	string	The name of the task flow.	Spark_SQL_test
OwnerName	string	The name of the task flow owner.	test_name
DagVersion	string	The version of the task flow.	[]
TotalCount	integer	The total number of execution records returned.	1

Examples

Success response

JSON format

{
  "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
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.