Run, resume, and retry workflow jobs¶
Start workflow jobs, track jobs, nodes, file executions, and results, and pause, resume, rerun, retry, cancel, or delete jobs when needed. This page does not modify workflow definitions; maintain workflows and templates in Manage workflows and templates.
Prerequisites¶
Prepare credentials that can access the target workspace and the ID of the workflow to run. For service endpoints, authentication, and general request formats, see Make your first AI Studio API call.
Before pausing, resuming, retrying, canceling, rerunning, or deleting an existing job, obtain its ID from the job list or details.
Call sequence¶
Start a workflow job and retain its job ID. For an existing job, list or get details first to identify the current object.
Query job details, nodes, file execution records, and job results to inspect the run, nodes, file processing, and output separately.
Refresh status to update current job information. To stop or continue temporarily, use pause and resume in that order.
When processing must run again, get the rerun plan first, then rerun from a specified node, or retry individual or batch jobs. Cancel a rerun or job when needed.
Delete a job only after confirming that it no longer needs to be retained.
API operations¶
Start and view jobs¶
Task |
Use it when |
|---|---|
Create one run for a workflow. |
|
Find a job or obtain a target job ID. |
|
Inspect current information for one job. |
|
View nodes in a job. |
|
Inspect file-processing records. |
|
Obtain or inspect a job result. |
|
Refresh the current job status. |
Control jobs¶
Task |
Use it when |
|---|---|
Stop a target job temporarily. |
|
Continue a paused job. |
|
You no longer need the target job to continue. |
|
You confirmed that the job no longer needs to be retained. |
Rerun and retry¶
Task |
Use it when |
|---|---|
Confirm an available plan before rerunning from a specified node. |
|
Start processing again from a selected node. |
|
Find existing rerun records. |
|
Inspect current information for one rerun. |
|
You no longer need the target rerun to continue. |
|
Retry one job. |
|
Retry multiple jobs together. |
Confirm the result¶
After starting, resuming, canceling, rerunning, or retrying, use Get workflow job details or Get a workflow rerun to inspect current information. To confirm output, use Get a workflow job result.
Limitations and notes¶
Starting, resuming, retrying, or rerunning means the relevant operation was initiated. Job details, nodes, file execution records, and results confirm later progress.
Before cancellation, deletion, or rerunning, confirm the impact on the target job and its output.