Skip to main content

List jobs

GET 
/metalakes/:metalake/jobs/runs

Returns the jobs in the metalake that the caller is allowed to see, with a count of the returned jobs by status. Query parameters narrow the jobs by template and by queue, start or finish time, and set the sort order.

Sign in with a bearer token or a local user's password; see Authentication.

Request​

Path Parameters

    metalake stringrequired

    The name of the metalake

Query Parameters

    jobTemplateName string

    The name of a job template. Only jobs run from this template are returned.

    queuedAfter date-time

    Only return jobs queued at or after this ISO-8601 instant (e.g. 2026-08-18T00:00:00Z). A job must satisfy all supplied time filters (AND semantics), so this combines with one or more of startedAfter and finishedAfter

    startedAfter date-time

    Only return jobs started at or after this ISO-8601 instant (e.g. 2026-08-18T00:00:00Z). Jobs that have not started yet are excluded. A job must satisfy all supplied time filters (AND semantics), so this combines with one or more of queuedAfter and finishedAfter

    finishedAfter date-time

    Only return jobs finished at or after this ISO-8601 instant (e.g. 2026-08-18T00:00:00Z). Jobs that have not finished yet are excluded. A job must satisfy all supplied time filters (AND semantics), so this combines with one or more of queuedAfter and startedAfter

    sortBy string

    Possible values: [queuedAt, startedAt, finishedAt]

    Default value: queuedAt

    The field to sort the returned jobs by. Jobs with no value for the selected field (e.g. jobs that have not started or finished yet) always sort last, for both the "asc" and "desc" sort orders

    sortOrder string

    Possible values: [asc, desc]

    Default value: desc

    The sort order for the returned jobs. It only orders the jobs that have a value for the selected sortBy field; jobs missing that value always sort last in both "asc" and "desc" order

Responses​

The jobs in the metalake that the caller can see, with a count of the returned jobs by status.

Schema

    code int32

    Possible values: [0]

    Status code of the response

    jobs

    object[]

    A list of job objects

  • Array [

    • jobId stringrequired

    The unique identifier of the job

    jobTemplateName stringrequired

    The name of the job template used to create the job

    status stringrequired

    Possible values: [queued, started, failed, succeeded, cancelling, cancelled]

    The status of the job

    audit

    object

    required

    Audit information for a Gravitino resource.

    creator string

    The user who created the resource

    createTime date-time

    The time the resource was created

    lastModifier string

    The user who last modified the resource

    lastModifiedTime date-time

    The time the resource was last modified

    queuedAt date-timerequired

    The time when the job was queued for execution, same as the job's creation time

    startedAt date-timenullable

    The time when the job started execution, or null if the job has not started execution yet

    finishedAt date-timenullable

    The time when the job finished execution, or null if the job has not finished execution yet

    runtimeJobTemplate

    object

    nullable

    oneOf

    A job template object for shell jobs

    name stringrequired

    The name of the job template

    jobType stringrequired

    Possible values: [shell]

    The type of the job template

    comment stringnullable

    A comment about the job template

    executable stringrequired

    The executable command of the job template

    arguments string[]nullable

    The arguments of the job template

    environments

    object

    Configured string to string map of environment variables for the job template

    property name* string

    customFields

    object

    Configured string to string map of custom fields for the job template

    property name* string
    scripts string[]nullable

    The scripts of the job template

    audit

    object

    Audit information for a Gravitino resource.

    creator string

    The user who created the resource

    createTime date-time

    The time the resource was created

    lastModifier string

    The user who last modified the resource

    lastModifiedTime date-time

    The time the resource was last modified

  • ]

    • statusCounts

    object

    The number of jobs in "jobs", keyed by lower-case status name. Every status is present, even at zero. Counted after queuedAfter/startedAfter/finishedAfter filtering, so a time filter can make some statuses structurally zero - e.g. startedAfter always yields queued: 0, since a queued job has no startedAt yet.

    property name* int64
Loading...
Last updated on