Sign in
Workflow API

Get Workflow Task

Changed on

Returns the task (with the latest retry_id) with the given name in the workflow.

get/api/workflow/{name}/task/{task_name}

Request

  • The document declares no server URL.
  • Auth: none declared

Path parameters

namestring required
task_namestring required

Response

Successful Response

workflow_idstring required
task_namestring required
nodestring nullable
start_timestring date-time nullable
end_timestring date-time nullable
status'SUBMITTING' | 'WAITING' | 'PROCESSING' | 'SCHEDULING' | 'INITIALIZING' | 'RUNNING' | 'COMPLETED' | 'RESCHEDULED' | 'FAILED' | 'FAILED_CANCELED' | 'FAILED_SERVER_ERROR' | 'FAILED_BACKEND_ERROR' | 'FAILED_EXEC_TIMEOUT' | 'FAILED_QUEUE_TIMEOUT' | 'FAILED_IMAGE_PULL' | 'FAILED_UPSTREAM' | 'FAILED_EVICTED' | 'FAILED_START_ERROR' | 'FAILED_START_TIMEOUT' | 'FAILED_PREEMPTED' required

Represents the status of a task group

storagenumber required
cpuinteger required
memorynumber required
gpuinteger required

Changes

  • b9d312a13f5dRevision changes
    • ○

      added the optional property // to the response with the status

    • ○

      added the optional property // to the response with the status

  • a8157dc3279dRevision changes
    • ▲

      response property end_time list-of-types was widened by adding types null to media type application/json of response 200

    • ▲

      response property node list-of-types was widened by adding types null to media type application/json of response 200

    • ▲

      response property start_time list-of-types was widened by adding types null to media type application/json of response 200

    • ▲

      the response's property type changed from integer to number for status

    • ▲

      the response's property type changed from no type to string for status

    • ▲

      the response's property type changed from integer to number for status