deploy.jobs.run

Run a job now, outside its schedule

POST /deploy/api/apps/{id}/jobs/{jobId}/runsIAM deploy:RunJobChanges state

Returns the run with status "requested"; the machine starts it within seconds. Read it back with runs.

Request syntax

POST /deploy/api/apps/{id}/jobs/{jobId}/runs

Path parameters

  • idRequired

    string

    Constraints: uuid

  • jobIdRequired

    string

    Constraints: uuid

Response

202 with `data`: the run — id, status requested, trigger, instanceId (the machine that will run it), createdAt; the result fields stay null until it finishes. 409 when no machine of the app has reported in yet.

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

Fields of data

  • idAlways

    string

    Run id
  • statusAlways

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

    requested, running, succeeded, failed, timed_out, skipped or lost
  • triggerAlways

    one of schedule, manual

    schedule or manual (run now)
  • instanceIdAlways

    string, may be null

    The machine that runs it (i-…); null if it was deleted
  • scheduledForAlways

    string, may be null

    The minute the schedule said; null for a run now
  • startedAtAlways

    string, may be null

    When it started; null until then
  • finishedAtAlways

    string, may be null

    When it finished; null until then
  • exitCodeAlways

    number, may be null

    Exit code; null until it finished
  • outputAlways

    string, may be null

    The last lines it printed (stdout and stderr)
  • errorAlways

    string, may be null

    Why it ended without an exit code of its own; null otherwise
  • createdAtAlways

    string

    When the run was recorded

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:RunJob 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 run id jobId

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