ListDownstreamTaskInstances - DataWorks - Alibaba Cloud Documentation Center

Queries a list of descendant instances of an instance by page.

Operation description

This API operation is available for all DataWorks editions.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
Id	long	Yes	The instance ID.	1234
PageSize	integer	No	The number of entries per page. Default value: 10.	10
PageNumber	integer	No	The page number. Pages start from page 1. Default value: 1.	1

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	22C97E95-F023-56B5-8852-B1A77A17XXXX
PagingInfo	object	The pagination information.
TaskInstances	array<object>	The instances. This parameter is deprecated and replaced by the DownstreamTaskInstances parameter.
TaskInstance	object
StepType	string	The scheduling dependency type. Valid values: Normal: same-cycle scheduling dependency CrossCycle: cross-cycle scheduling dependency	Normal
TaskId	long	The ID of the task for which the instance is generated.	1234
TaskType	string	The type of the task for which the instance is generated.	ODPS_SQL
TaskName	string	The name of the task for which the instance is generated.	SQL node
Description	string	The description.	test
WorkflowId	long	The ID of the workflow to which the instance belongs.	1234
WorkflowName	string	The name of the workflow to which the instance belongs.	Test workflow
TriggerType	string	The method to trigger instance scheduling. Valid values: Scheduler: scheduling cycle-based trigger Manual: manual trigger	Scheduler
TriggerRecurrence	string	The running mode of the instance after it is triggered. This parameter takes effect only if the TriggerType parameter is set to Scheduler. Valid values: Pause Skip Normal	Normal
WorkflowInstanceId	long	The workflow instance ID.	1234
WorkflowInstanceType	string	The type of the workflow instance. Valid values: SmokeTest SupplementData Manual ManualWorkflow Normal ManualFlow	Normal
Timeout	integer	The timeout period of task running. Unit: seconds. Note: The value of this parameter is rounded up by hour.	1
RerunMode	string	The rerun mode. Valid values: AllDenied: The task cannot be rerun regardless of whether it is successfully run or fails to run. FailureAllowed: The task can be rerun only after it fails to run. AllAllowed: The task can be rerun regardless of whether it is successfully run or fails to run.	AllAllowed
RunNumber	integer	The number of times the instance is run. By default, the value starts from 1.	1
PeriodNumber	integer	The sequence number of the cycle. This parameter indicates the cycle of the task instance on the current day.	1
BaselineId	long	The baseline ID.	1234
Priority	integer	The priority of the task. Valid values: 1 to 8. A larger value indicates a higher priority. Default value: 1.	1
RuntimeResource	object	The information about the resource group with which the instance is associated.
ResourceGroupId	string	The ID of the resource group for scheduling configured for task running.	S_res_group_524258031846018_1684XXXXXXXXX
Image	string	The ID of the image configured for task running.	i-xxxxxx
Cu	string	The default number of compute units (CUs) configured for task running.	0.25
Runtime	object	The runtime information about the instance.
ProcessId	string	The instance run ID.	T3_123
Gateway	string	The host for running.	cn-shanghai.1.2
DataSource	object	The information about the associated data source.
Name	string	The name of the data source.	mysql_test
Status	string	The status of the instance. Valid values: NotRun: The instance is not run. Running: The instance is running. WaitTime: The instance is waiting for the scheduling time to arrive. CheckingCondition: Branch conditions are being checked for the instance. WaitResource: The instance is waiting for resources. Failure: The instance fails to be run. Success: The instance is successfully run. Checking: Data quality is being checked for the instance. WaitTrigger: The instance is waiting to be triggered by external scheduling systems.	Success
TriggerTime	long	The scheduling time.	1710239005403
Bizdate	long	The data timestamp.	1710239005403
StartedTime	long	The time when the instance started to run.	1710239005403
FinishedTime	long	The time when the instance finished running.	1710239005403
Id	long	The instance ID.	1234
ProjectId	long	The workspace ID.	100
ProjectEnv`deprecated`	string	The environment of the workspace. This parameter is deprecated and replaced by the EnvType parameter. Valid values:	Prod
EnvType	string	The environment in which the data source is used. Valid values: Dev Prod	Prod
Owner	string	The account ID of the task owner.	100
CreateTime	long	The creation time.	1710239005403
ModifyTime	long	The modification time.	1710239005403
CreateUser	string	The account ID of the creator.	1000
ModifyUser	string	The account ID of the modifier.	1000
DownstreamTaskInstances	array<object>	The descendant instances.
DownstreamTaskInstance	object
DependencyType	string	The scheduling dependency type. Valid values: Normal CrossCycle	Normal
TaskInstance	object	The information about a task instance.
TaskId	long	The ID of the task for which the instance is generated.	1234
TaskType	string	The type of the task for which the instance is generated.	ODPS_SQL
TaskName	string	The name of the task for which the instance is generated.	SQL node
Description	string	The description.	test
WorkflowId	long	The ID of the workflow to which the instance belongs.	1234
WorkflowName	string	The name of the workflow to which the instance belongs.	Test workflow
TriggerType	string	The trigger type. Valid values: Scheduler: scheduling cycle-based trigger Manual: manual trigger	Scheduler
TriggerRecurrence	string	The running mode of the instance after it is triggered. This parameter takes effect only if the TriggerType parameter is set to Scheduler. Valid values: Pause Skip Normal	Normal
WorkflowInstanceId	long	The workflow instance ID.	1234
WorkflowInstanceType	string	The type of the workflow instance. Valid values: Normal Manual SmokeTest SupplementData ManualWorkflow	Normal
Timeout	integer	The timeout period of task running. Unit: seconds. Note: The value of this parameter is rounded up by hour.	3600
RerunMode	string	The rerun mode.	AllAllowed
RunNumber	integer	The number of times the instance is run. By default, the value starts from 1.	1
PeriodNumber	integer	The sequence number of the cycle. This parameter indicates the cycle of the task instance on the current day.	1
BaselineId	long	The baseline ID.	1234
Priority	integer	The priority of the task. Minimum value: 1. Maximum value: 8. A larger value indicates a higher priority. Default value: 1.	1
RuntimeResource	object	The configurations of the runtime environment, such as the resource group information.
ResourceGroupId	string	The ID of the resource group for scheduling configured for task running.	S_res_group_524258031846018_1684XXXXXXXXX
Image	string	The ID of the image configured for task running.	i-xxxxxx
Cu	string	The default number of compute units (CUs) configured for task running.	0.25
Runtime	object	The runtime information about the instance.
ProcessId	string	The instance run ID.	T3_123
Gateway	string	The host for running.	cn-shanghai.1.2
DataSource	object	The information about the associated data source.
Name	string	The name of the data source.	mysql_test
Status	string	The status of the instance. Valid values: NotRun: The instance is not run. Running: The instance is running. WaitTime: The instance is waiting for the scheduling time to arrive. CheckingCondition: Branch conditions are being checked for the instance. WaitResource: The instance is waiting for resources. Failure: The instance fails to be run. Success: The instance is successfully run. Checking: Data quality is being checked for the instance. WaitTrigger: The instance is waiting to be triggered by external scheduling systems.	Success
TriggerTime	long	The scheduling time.	1710239005403
Bizdate	long	The data timestamp.	1710239005403
StartedTime	long	The time when the instance started to run.	1710239005403
FinishedTime	long	The time when the instance finished running.	1710239005403
Id	long	The instance ID.	1234
ProjectId	long	The workspace ID.	100
EnvType	string	The environment in which the data source is used. Valid values: Dev Prod	Prod
Owner	string	The account ID of the task owner.	1000
CreateTime	long	The creation time.	1710239005403
ModifyTime	long	The modification time.	1710239005403
CreateUser	string	The account ID of the creator.	1000
ModifyUser	string	The account ID of the modifier.	1000
TotalCount	integer	The total number of entries returned.	100
PageSize	integer	The number of entries per page.	10
PageNumber	integer	The page number.	1

Examples

Sample success responses

JSONformat

{
  "RequestId": "22C97E95-F023-56B5-8852-B1A77A17XXXX",
  "PagingInfo": {
    "TaskInstances": [
      {
        "StepType": "Normal",
        "TaskId": 1234,
        "TaskType": "ODPS_SQL",
        "TaskName": "SQL node",
        "Description": "test",
        "WorkflowId": 1234,
        "WorkflowName": "Test workflow",
        "TriggerType": "Scheduler",
        "TriggerRecurrence": "Normal",
        "WorkflowInstanceId": 1234,
        "WorkflowInstanceType": "Normal",
        "Timeout": 1,
        "RerunMode": "AllAllowed",
        "RunNumber": 1,
        "PeriodNumber": 1,
        "BaselineId": 1234,
        "Priority": 1,
        "RuntimeResource": {
          "ResourceGroupId": "S_res_group_524258031846018_1684XXXXXXXXX",
          "Image": "i-xxxxxx",
          "Cu": 0.25
        },
        "Runtime": {
          "ProcessId": "T3_123\n",
          "Gateway": "cn-shanghai.1.2"
        },
        "DataSource": {
          "Name": "mysql_test\n"
        },
        "Status": "Success",
        "TriggerTime": 1710239005403,
        "Bizdate": 1710239005403,
        "StartedTime": 1710239005403,
        "FinishedTime": 1710239005403,
        "Id": 1234,
        "ProjectId": 100,
        "ProjectEnv": "Prod",
        "EnvType": "Prod",
        "Owner": 100,
        "CreateTime": 1710239005403,
        "ModifyTime": 1710239005403,
        "CreateUser": 1000,
        "ModifyUser": 1000
      }
    ],
    "DownstreamTaskInstances": [
      {
        "DependencyType": "Normal",
        "TaskInstance": {
          "TaskId": 1234,
          "TaskType": "ODPS_SQL",
          "TaskName": "SQL node",
          "Description": "test",
          "WorkflowId": 1234,
          "WorkflowName": "Test workflow",
          "TriggerType": "Scheduler",
          "TriggerRecurrence": "Normal",
          "WorkflowInstanceId": 1234,
          "WorkflowInstanceType": "Normal",
          "Timeout": 3600,
          "RerunMode": "AllAllowed",
          "RunNumber": 1,
          "PeriodNumber": 1,
          "BaselineId": 1234,
          "Priority": 1,
          "RuntimeResource": {
            "ResourceGroupId": "S_res_group_524258031846018_1684XXXXXXXXX",
            "Image": "i-xxxxxx",
            "Cu": 0.25
          },
          "Runtime": {
            "ProcessId": "T3_123",
            "Gateway": "cn-shanghai.1.2"
          },
          "DataSource": {
            "Name": "mysql_test"
          },
          "Status": "Success",
          "TriggerTime": 1710239005403,
          "Bizdate": 1710239005403,
          "StartedTime": 1710239005403,
          "FinishedTime": 1710239005403,
          "Id": 1234,
          "ProjectId": 100,
          "EnvType": "Prod",
          "Owner": 1000,
          "CreateTime": 1710239005403,
          "ModifyTime": 1710239005403,
          "CreateUser": 1000,
          "ModifyUser": 1000
        }
      }
    ],
    "TotalCount": 100,
    "PageSize": 10,
    "PageNumber": 1
  }
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2025-01-21	The response structure of the API has changed	View Change Details
2025-01-06	The response structure of the API has changed	View Change Details
2024-11-20	The response structure of the API has changed	View Change Details