All Products
Search

This Product

    Platform For AI:ListJobs

    Document Center

    Platform For AI:ListJobs

    Last Updated:Feb 12, 2026

    Retrieves a list of jobs. This operation supports paging, sorting, and filtering.

    Try it now

    Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

    Test

    RAM authorization

    The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

    • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

    • API: The API that you can call to perform the action.

    • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

    • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

      • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

      • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

    • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

    • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

    Action

    Access level

    Resource type

    Condition key

    Dependent action

    paidlc:ListJobs

    get

    *All Resource

    *

    		 None None

    Request syntax

    GET /api/v1/jobs HTTP/1.1

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    DisplayName

    string

    No

    The job name. This parameter supports fuzzy query and is case-insensitive. Wildcard characters are not supported. For example, an input of test matches test-job1, job-test, job-test2, and job-Test. It does not match job-t1. The default value is empty, which means any job name.

    tf-mnist-test
    JobType

    string

    No

    The job type. The default value is empty, which indicates all types. Supported job types include the following:

    • TFJob

    • PyTorchJob

    • XGBoostJob

    • OneFlowJob

    • ElasticBatchJob

    TFJob
    Status

    string

    No

    The job status. Valid values:

    • Creating

    • Queuing

    • Bidding (This status applies only to Lingjun Spot jobs)

    • EnvPreparing

    • SanityChecking

    • Running

    • Restarting

    • Stopping

    • SucceededReserving

    • FailedReserving

    • Succeeded

    • Failed

    • Stopped

    Running
    StartTime

    string

    No

    The start of the time range to query. Jobs are filtered by their creation time. The default value is seven days before the current time. If you do not set StartTime and EndTime, the system queries the list of jobs from the last seven days.

    2025-04-16T07:25:34Z
    EndTime

    string

    No

    The end of the time range to query. Jobs are filtered by their creation time. The default value is the current time.

    2025-04-16T07:26:41Z
    PageNumber

    integer

    No

    The page number for a paged query. The value starts from 1. The default value is 1.

    1
    PageSize

    integer

    No

    The number of jobs to return on each page.

    50
    SortBy

    string

    No

    The sorting field. Valid values:

    • DisplayName

    • JobType

    • Status

    • GmtCreateTime

    • GmtFinishTime

    GmtCreateTime
    Order

    string

    No

    The sort order. Valid values:

    • desc: descending order. This is the default value.

    • asc: ascending order.

    Valid values:

    • asc :

      ascending order

    • desc :

      descending order

    desc
    ShowOwn

    boolean

    No

    Set to true to list only the jobs submitted by the current user.

    true
    WorkspaceId

    string

    No

    The ID of the workspace.

    1****
    ResourceId

    string

    No

    The ID of the resource group. For more information about how to query the ID of a dedicated resource group, see Manage resource quotas.

    r*****
    BusinessUserId

    string

    No

    The user ID associated with the job.

    16****
    Caller

    string

    No

    The caller.

    local
    Tags

    object

    No

    The tags used to filter jobs.

    string

    No

    A single tag.

    recommandation
    PipelineId

    string

    No

    Filter jobs by the specified workflow ID.

    flow-*******
    FromAllWorkspaces

    boolean

    No

    Set to true to retrieve the list of jobs from all workspaces. Use this parameter with ShowOwn=true to query the list of jobs that the current user recently submitted.

    false
    JobId

    string

    No

    The job ID. The ID is not case-sensitive. Fuzzy queries and wildcard characters are not supported. The default value is empty, which returns all jobs.

    dlc********
    UserIdForFilter

    string

    No

    Filter the list of jobs by the user ID of the job submitter.

    20**************
    Username

    string

    No

    Filter the job list by the username of the job submitter. Fuzzy queries are supported, but wildcard characters are not. The default value is empty, which means that the job list is not filtered by username.

    test***
    ResourceQuotaName

    string

    No

    Filter the list of jobs by the name of the resource quota. Fuzzy match is supported. Wildcard characters are not supported. If you leave this parameter empty, jobs are not filtered by resource quota.

    quota***
    Accessibility

    string

    No

    The visibility of the job. Valid values:

    • PUBLIC: The job is visible to everyone in this workspace.

    • PRIVATE (default): The job is visible only to you and administrators in this workspace.

    Valid values:

    • PUBLIC :

      PUBLIC

    • PRIVATE :

      PRIVATE

    PRIVATE
    OversoldInfo

    string

    No

    Information about idle resources. Possible values:

    • ForbiddenQuotaOverSold

    • ForceQuotaOverSold

    • AcceptQuotaOverSold-true (true indicates that the job used idle resources)

    • AcceptQuotaOverSold-false (false indicates that the job used guaranteed resources)

    ForbiddenQuotaOverSold
    PaymentType

    string

    No

    The resource type. Valid values:

    • PrePaid: resource quota

    • Spot: preemptible resources

    • PostPaid: public resources

    PostPaid
    JobIds

    string

    No

    A list of job IDs. Separate multiple IDs with commas. If you set this parameter and JobId at the same time, JobId takes precedence.

    dlc123abc
    DisplayNameSearchMode

    string

    No

    The search mode for DisplayName. The default value is wildcard matching.

    Valid values:

    • prefix :

      prefix

    • fulltext :

      fulltext

    • term :

      term

    • wildcard :

      wildcard

    wildcard
    ReasonSearch

    string

    No

    Perform a full-text search in the job failure reason (reason) field. Supports Chinese and English tokenization.

    OOM
    UserCommandSearch

    string

    No

    Perform a full-text search in the user command (user_command) field. Supports Chinese and English tokenization.

    python train.py
    ImageSearch

    string

    No

    Perform a full-text search in the image (images) field. Supports Chinese and English tokenization.

    pytorch
    TimeRangeField

    string

    No

    Specify the time field used for StartTime/EndTime filtering. If left empty, the creation time is used by default.

    GmtFinishTime
    NumericRangeField

    string

    No

    The field name for numeric range filtering. Use this parameter with NumericRangeMin/NumericRangeMax.

    RequestGPU
    NumericRangeMin

    integer

    No

    The minimum value (inclusive) for numeric range filtering. Use this parameter with NumericRangeField.

    4

    NumericRangeMax

    integer

    No

    The maximum value (inclusive) for numeric range filtering. Use this parameter with NumericRangeField.

    8
    EnableAssignNode

    string

    No

    Filter jobs based on whether they are enabled to run on specified nodes.

    Valid values:

    • true :

      true

    • false :

      false

    true
    TemplateId

    string

    No

    The template ID. Filter jobs created from the specified template.

    tmlabc123

    Response elements

    Element

    Type

    Description

    Example

    object

    The list of jobs.

    Jobs

    array

    The list of jobs.

    JobItem

    A single job.

    TotalCount

    integer

    The total number of jobs that meet the filter condition.

    1
    RequestId

    string

    The ID of the request, used for diagnostics and support.

    473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.