deploy.jobs.list

List an app’s jobs with their schedule in words, next run and last result

GET /deploy/api/apps/{id}/jobsIAM deploy:DescribeJobsRead

Request syntax

GET /deploy/api/apps/{id}/jobs

Path parameters

  • idRequired

    string

    Constraints: uuid

Response

200 with `data`: `runnerInstanceId` (the machine that runs the jobs, or null before one has reported in) and `jobs` — each with id, name, schedule, scheduleDescription, command, service, timezone, enabled, timeoutSec, concurrency, nextRunAt (null when disabled), lastRun (status, trigger, exitCode, times; or null), createdAt and updatedAt.

A JSON response is wrapped as { "success": true, "data": … }; the CLI prints the whole body with --json.

Fields of data

  • runnerInstanceIdAlways

    string, may be null

    The machine that runs the jobs; null before one has reported in
  • jobsAlways

    array of object

    The app’s jobs
  • jobs[].​idAlways

    string

    Job id
  • jobs[].​nameAlways

    string

    Name, unique in the app
  • jobs[].​scheduleAlways

    string

    Cron expression, in UTC
  • jobs[].​scheduleDescriptionAlways

    string

    The schedule in words, or why it cannot be read
  • jobs[].​commandAlways

    string

    Command run with /bin/sh -c
  • jobs[].​serviceAlways

    string, may be null

    Compose apps: the service it runs in; null: the published service
  • jobs[].​timezoneAlways

    string

    Time zone of the schedule (UTC)
  • jobs[].​enabledAlways

    boolean

    Whether it runs on its schedule
  • jobs[].​timeoutSecAlways

    number

    Seconds a run may take before it is stopped
  • jobs[].​concurrencyAlways

    one of skip, allow

    skip: a due run is skipped while the previous one runs; allow: it starts anyway
  • jobs[].​nextRunAtAlways

    string, may be null

    When it runs next; null when disabled
  • jobs[].​lastRunAlways

    object, may be null

    Its newest run; null if it never ran
  • jobs[].​lastRun.​idAlways

    string

    Run id
  • jobs[].​lastRun.​statusAlways

    one of requested, running, succeeded, failed, timed_out, skipped, lost

    requested, running, succeeded, failed, timed_out, skipped or lost
  • jobs[].​lastRun.​triggerAlways

    one of schedule, manual

    schedule or manual (run now)
  • jobs[].​lastRun.​exitCodeAlways

    number, may be null

    Exit code; null until it finished
  • jobs[].​lastRun.​startedAtAlways

    string, may be null

    When it started
  • jobs[].​lastRun.​finishedAtAlways

    string, may be null

    When it finished
  • jobs[].​lastRun.​createdAtAlways

    string

    When the run was recorded
  • jobs[].​createdAtAlways

    string

    When it was created
  • jobs[].​updatedAtAlways

    string

    When it was last changed

Checked against the handlers: every route test validates their answers against this schema.

Errors

  • 400The request does not pass the schema above. The body is { "error": …, "issues": […] }, one issue per field.
  • 401No credentials, or an access key that is unknown, revoked or expired.
  • 403The caller's policies do not allow deploy:DescribeJobs on this resource. The body names the action and the resource, and the refusal is recorded in the audit log.
  • 404The resource does not exist in your organization.

Examples

The required parameters only, with example values. Replace id and the other placeholders with your own.

dcloud deploy jobs list id

Generated from the API description, the same one the API checks requests against and the CLI is built from. MCP tool: dcloud_deploy_jobs_list.