全部產品
Search

搜尋本產品

    Platform For AI：ListJobs - 擷取工作清單

    文件中心

    Platform For AI：ListJobs - 擷取工作清單

    更新時間：Feb 12, 2026

    擷取工作清單，支援分頁、排序和按條件過濾。

    調試

    您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

    調試

    授權資訊

    下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

    • 操作：是指具體的許可權點。

    • 存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。

    • 資源類型：是指操作中支援授權的資源類型。具體說明如下：

      • 對於必選的資源類型，用前面加 * 表示。

      • 對於不支援資源級授權的操作，用全部資源表示。

    • 條件關鍵字：是指雲產品自身定義的條件關鍵字。

    • 關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    paidlc:ListJobs

    get

    *全部資源

    *

    		 無 無

    請求文法

    GET /api/v1/jobs HTTP/1.1

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    DisplayName

    string

    否

    任務名稱，支援模糊查詢，大小寫不敏感，不支援萬用字元。 例如：輸入 test，可以匹配 test-job1、job-test、job-test2 或 job-Test；但是不能匹配 job-t1。 預設為空白，代表任意任務名稱。

    tf-mnist-test
    JobType

    string

    否

    任務類型，預設為空白，代表所有類型。支援的任務類型如下：

    • TFJob

    • PyTorchJob

    • XGBoostJob

    • OneFlowJob

    • ElasticBatchJob

    TFJob
    Status

    string

    否

    任務運行狀態，可能值：

    • Creating

    • Queuing

    • Bidding (當前僅限靈駿 Spot 作業)

    • EnvPreparing

    • SanityChecking

    • Running

    • Restarting

    • Stopping

    • SucceededReserving

    • FailedReserving

    • Succeeded

    • Failed

    • Stopped

    Running
    StartTime

    string

    否

    查詢區間的起始時間；使用任務的建立時間來過濾。預設值是目前時間減去 7 天，即：如果 StartTime 與 EndTime 都沒有配置時，預設查詢最近 7 天的工作清單。

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

    string

    否

    查詢區間的截止時間；使用任務的建立時間來過濾。預設值是當前時刻。

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

    integer

    否

    分頁查詢，指定當前需要返回的頁碼，起始值為 1，預設為 1。

    1
    PageSize

    integer

    否

    每頁返回的任務數量。

    50
    SortBy

    string

    否

    排序欄位：

    • DisplayName

    • JobType

    • Status

    • GmtCreateTime

    • GmtFinishTime

    GmtCreateTime
    Order

    string

    否

    排列順序，支援：

    • desc：降序，預設值。

    • asc：升序。

    枚舉值：

    • asc :

      asc

    • desc :

      desc

    desc
    ShowOwn

    boolean

    否

    是否只查詢目前使用者提交的工作清單。

    true
    WorkspaceId

    string

    否

    工作空間 ID。

    1****
    ResourceId

    string

    否

    資源群組 ID。如何查詢專有資源群組 ID，詳情請參見管理資源配額。

    r*****
    BusinessUserId

    string

    否

    任務關聯使用者識別碼。

    16****
    Caller

    string

    否

    調用方。

    local
    Tags

    object

    否

    用於過濾的標籤。

    string

    否

    單個標籤。

    recommandation
    PipelineId

    string

    否

    過濾指定工作流程 ID 建立的任務。

    flow-*******
    FromAllWorkspaces

    boolean

    否

    是否跨工作空間擷取工作清單，需要配合ShowOwn=true參數使用，可以查詢目前使用者最近提交的工作清單。

    false
    JobId

    string

    否

    任務 ID，不支援模糊查詢，對大小寫不敏感。不支援萬用字元。 預設為空白，代表任意任務 ID。

    dlc********
    UserIdForFilter

    string

    否

    按任務提交者的使用者識別碼，過濾查詢工作清單。

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

    string

    否

    按任務提交者的使用者名稱，過濾查詢工作清單。支援模糊查詢，不支援萬用字元。預設為空白，表示不過濾使用者名稱。

    test***
    ResourceQuotaName

    string

    否

    按資源配額的名字，過濾查詢工作清單。支援模糊比對，不支援萬用字元。預設為空白，表示不過濾資源配額。

    quota***
    Accessibility

    string

    否

    作業的可見度，取值如下：

    • PUBLIC：在此工作空間中，對所有人可見。

    • PRIVATE（預設值）：在此工作空間中，僅對您和管理員可見。

    枚舉值：

    • PUBLIC :

      PUBLIC

    • PRIVATE :

      PRIVATE

    PRIVATE
    OversoldInfo

    string

    否

    閑時資源資訊，可能的取值

    • ForbiddenQuotaOverSold

    • ForceQuotaOverSold

    • AcceptQuotaOverSold-true （true 表示作業實際使用了閑時資源）

    • AcceptQuotaOverSold-false （false 表示作業實際使用了保障資源）

    ForbiddenQuotaOverSold
    PaymentType

    string

    否

    資源類型，取值如下：

    • PrePaid：資源配額

    • Spot：競價資源

    • PostPaid：公用資源

    PostPaid
    JobIds

    string

    否

    任務 ID 列表，多個 ID 用英文逗號分隔。與 JobId 同時設定時，以 JobId 為準。

    dlc123abc
    DisplayNameSearchMode

    string

    否

    DisplayName 搜尋模式。預設為萬用字元匹配。

    枚舉值：

    • prefix :

      prefix

    • fulltext :

      fulltext

    • term :

      term

    • wildcard :

      wildcard

    wildcard
    ReasonSearch

    string

    否

    在任務失敗原因(reason)欄位中進行全文檢索索引，支援中英文分詞。

    OOM
    UserCommandSearch

    string

    否

    在使用者命令(user_command)欄位中進行全文檢索索引，支援中英文分詞。

    python train.py
    ImageSearch

    string

    否

    在鏡像(images)欄位中進行全文檢索索引，支援中英文分詞。

    pytorch
    TimeRangeField

    string

    否

    指定 StartTime/EndTime 篩選使用的時間欄位。不填預設為建立時間。

    GmtFinishTime
    NumericRangeField

    string

    否

    數值範圍篩選的欄位名。需配合 NumericRangeMin/NumericRangeMax 使用。

    RequestGPU
    NumericRangeMin

    integer

    否

    數值範圍篩選的最小值（包含）。需配合 NumericRangeField 使用。

    4

    NumericRangeMax

    integer

    否

    數值範圍篩選的最大值（包含）。需配合 NumericRangeField 使用。

    8
    EnableAssignNode

    string

    否

    篩選是否啟用指定節點啟動並執行任務。

    枚舉值：

    • true :

      true

    • false :

      false

    true
    TemplateId

    string

    否

    模板 ID，用於篩選由指定模板建立的任務。

    tmlabc123

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    工作清單。

    Jobs

    array

    工作清單。

    JobItem

    單個任務。

    TotalCount

    integer

    符合過濾條件的總任務數。

    1
    RequestId

    string

    請求 ID，用於診斷和答疑。

    473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

    錯誤碼

    訪問錯誤中心查看更多錯誤碼。

    變更歷史

    更多資訊，參考變更詳情。