komrad

list_schedule_runs

List a live or archived schedule's newest runs, newest first, each with its state and why it was skipped or failed.

read-onlyidempotentMCP toolSchedule

Calling it#

curl -X POST http://127.0.0.1:8787/komrad.schedule.v1.ScheduleService/ListScheduleRuns \
  -H 'Content-Type: application/json' \
  -d '{
  "id": "<id>"
}'

Request#

ListScheduleRunsRequest#

FieldTypeDescription
iduuid*

The schedule whose runs to list, by id.

limitint32

between 0 and 200

How many of the newest runs to return. Zero returns twenty.

Response#

ListScheduleRunsResponse#

FieldTypeDescription
runsScheduleRun[]

The schedule's runs on record, newest first.

Types#

ScheduleRun#

ScheduleRun is one time a schedule's cron expression matched, with its state.

FieldTypeDescription
idint64

The run's id. A higher id is a newer run.

scheduled_fortimestamp

The time the cron expression matched for this run.

stateScheduleRunState

The run's state.

attemptint32

The run's current attempt, counting from one once the run has started.

max_attemptsint32

How many attempts the run has before it is discarded.

finalized_attimestamp

When the run finished. Unset while the run is waiting or running.

messagestring

Why the run was skipped, or the error from its last failed attempt. Empty when the run completed.

ScheduleRunState#

ScheduleRunState is the state of one schedule run.

ValueDescription
available

Waiting to start.

pending

Held back until something releases the run.

scheduled

Waiting for a later time to start.

running

Running now.

retryable

Failed an attempt and waiting to try again.

completed

Launched the run's agent or sent the run's mail.

cancelled

Skipped, with the reason in the run's message.

discarded

Out of attempts, with the last error in the run's message.