ds_list_process_instances
Lists project process instances in Apache DolphinScheduler, filtered by workflow code and state, to track execution progress and troubleshoot failed or running workflows.
Instructions
List process instances (filter by workflow_code, state).
v2.0.12: merged ds_list_workflow_instances.
workflow_code=0 (default): list all recent instances in the project
workflow_code=: list instances for that specific workflow
Troubleshooting / Progress Tracking (v2.0.18): After getting instances, to understand execution details (which tasks running/failed/stuck), use ds_list_task_instances(process_instance_id=, include_full=True) to view task states:
RUNNING_EXECUTION: instance running but no details → check task list for dispatched/running tasks (RUNNING instance with empty task list is normal — DS is initializing DAG)
FAILURE: locate failed tasks → find FAILURE tasks, then check their logs Each RUNNING/FAILURE instance returned includes a next_action hint.
Args: project_name: Project name workflow_code: Process-definition code (0 = no filter, list all instances) state: State filter (FAILURE / SUCCESS / RUNNING_EXECUTION / STOP, empty = no filter) page_size: Number of items to return
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"project_name": "<project_name>"
},
"name": "ds_list_process_instances"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| state | No | ||
| page_size | No | ||
| project_name | Yes | ||
| workflow_code | No |