全部產品
Search

搜尋本產品

    Elastic High Performance Computing：ListJobs - 查詢作業列表

    文件中心

    Elastic High Performance Computing：ListJobs - 查詢作業列表

    更新時間：Feb 25, 2026

    查詢指定叢集中的作業列表。

    調試

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

    調試

    授權資訊

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

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

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

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

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

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

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

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

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    ehpc:ListJobs

    list

    *全部資源

    *

    		 無 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    ClusterId

    string

    是

    叢集 ID。

    您可以通過調用 ListClusters 擷取叢集 ID。

    ehpc-hz-csbua72***
    PageNumber

    string

    否

    列表的當前頁碼。

    • 起始值為 1

    • 預設值為 1

    1
    PageSize

    string

    否

    列表分頁查詢時每頁行數。

    • 最大值：50

    • 預設值：10

    10
    JobFilter

    object

    否

    作業過濾資訊。

    Users

    array

    否

    執行作業的使用者列表資訊。

    string

    否

    執行作業的使用者名稱。支援模糊查詢。

    可通過調用 ListUsers 擷取該叢集中的使用者名稱。

    testuser1
    Queues

    array

    否

    執行作業的隊列列表資訊。

    string

    否

    執行作業的隊列名稱。支援模糊查詢。

    comp
    Nodes

    array

    否

    執行作業的計算節點列表資訊。

    string

    否

    計算節點主機名稱。支援模糊查詢。

    compute000
    JobName

    string

    否

    作業名稱。支援模糊查詢。

    testjob
    JobStatus

    string

    否

    作業狀態。取值範圍：

    • all：所有狀態。

    • finished：已完成。

    • notfinish：未完成。

    預設值：all。

    all
    CreateTimeStart

    string

    否

    作業開始時間。格式為 Unix 時間戳記，表示從 1970-01-01T00:00:00Z 起所經過的秒數。

    1724122486
    CreateTimeEnd

    string

    否

    作業最後更新時間。格式為 Unix 時間戳記，表示從 1970-01-01T00:00:00Z 起所經過的秒數。

    1724123085
    SortBy

    object

    否

    作業列表排序方式配置。

    ExecuteOrder

    string

    否

    按照作業執行時間進行排序。取值範圍：

    • asc：升序。

    • desc：降序。

    預設值：desc。

    asc
    SubmitOrder

    string

    否

    按照作業提交時間進行排序。取值範圍：

    • asc：升序。

    • desc：降序。

    預設值：desc。

    asc
    PendOrder

    string

    否

    按照作業排隊時間進行排序。取值範圍：

    • asc：升序。

    • desc：降序。

    預設值：desc。

    desc
    Diagnosis

    array<object>

    否

    作業診斷分析列表。

    object

    否

    作業診斷分析詳情。

    Option

    string

    否

    作業診斷分析指標項。

    run_duration
    Operator

    string

    否

    作業診斷閾值比較符。

    枚舉值：

    • greater_or_equal :

      大於等於

    • less :

      小於

    • less_or_equal :

      小於等於

    • greater :

      大於

    greater
    Threshold

    string

    否

    作業診斷閾值。

    24

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    返回資訊集合。

    TotalCount

    integer

    本次請求條件下的資料總條數。

    10
    RequestId

    string

    請求 ID。

    EABFBD93-58BE-53F3-BBFE-8654BB2E****
    PageNumber

    integer

    當前頁碼。預設值：1。

    1
    PageSize

    integer

    分頁查詢時設定的本頁條數。預設值：10。

    20
    Success

    boolean

    執行命令並擷取結果的過程是否成功。可能值：

    • true：成功。

    • false：失敗。

    true
    Jobs

    array<object>

    作業列表。

    array<object>

    作業資訊列表。

    JobName

    string

    作業名稱。

    testjob
    JobSpec

    object

    作業配置資訊。

    Id

    string

    作業 ID。

    12
    RunasUser

    string

    執行該作業的使用者名稱。

    testuser1
    Comment

    string

    作業描述資訊。

    jobDescription
    State

    string

    作業狀態。可能值：（PBS 叢集/Slurm 叢集）

    • FINISHED/Completed：已完成。

    • RUNNING/Running：運行中。

    • QUEUED/Pending：排隊等待。

    • FAILED/Failed：執行失敗。

    Running
    StderrPath

    string

    錯誤輸出路徑。

    ./Temp
    StdoutPath

    string

    標準輸出路徑。

    ./Temp
    Priority

    string

    處理作業的優先順序。取值範圍：0~9，取值越大，優先順序越高。

    0
    ArrayRequest

    string

    隊列作業格式。

    • 如果不是隊列作業，輸出為空白。

    • 格式為 X-Y:Z， 最小值 X 是第一個索引，最大值 Y 是最後一個索引，Z 表示步長，例如 2-7:2，表示作業隊列包含編號為 2、4、6 的 3 個子作業。

    1-5:2
    LastModifyTime

    string

    作業最後更新時間。

    1724123085
    NodeList

    string

    運行作業的計算節點列表。

    compute[002,005,003]
    SubmitTime

    string

    作業提交時間。

    1724122486
    JobQueue

    string

    執行作業的隊列名。

    comp
    Variables

    string

    作業的變數列表。

    {"PBS_O_SHELL":"/bin/bash", "PBS_O_HOST":"manager", "PBS_O_SYSTEM":"Linux", "PBS_O_LANG":"en_US.UTF-8", "PBS_O_QUEUE":"workq"}
    Resources

    object

    作業運行所需資源資訊。

    Nodes

    string

    運行作業的計算節點數量。

    3
    Cores

    string

    運行作業的 CPU 核心數。

    6
    Memory

    string

    運行作業的記憶體大小。

    1536MB
    Gpus

    string

    運行作業的 GPU 數量。

    0
    ArrayJobId

    string

    數組作業 ID。

    4
    ArrayJobSubId

    string

    數組子作業 ID。

    1
    ResourcesActualOccupied

    object

    作業程式實際佔用資源。

    Nodes

    string

    計算節點數。

    2
    Cores

    string

    CPU 核心數。

    4
    Memory

    string

    記憶體數。

    982MB
    Gpus

    string

    CPU 數。

    0
    StartTime

    string

    作業開始時間。

    1724122486

    樣本

    正常返回樣本

    JSON格式

    {
  "TotalCount": 10,
  "RequestId": "EABFBD93-58BE-53F3-BBFE-8654BB2E****",
  "PageNumber": 1,
  "PageSize": 20,
  "Success": true,
  "Jobs": [
    {
      "JobName": "testjob",
      "JobSpec": {
        "Id": "12",
        "RunasUser": "testuser1",
        "Comment": "jobDescription",
        "State": "Running",
        "StderrPath": "./Temp",
        "StdoutPath": "./Temp",
        "Priority": "0",
        "ArrayRequest": "1-5:2",
        "LastModifyTime": "1724123085",
        "NodeList": "compute[002,005,003]",
        "SubmitTime": "1724122486",
        "JobQueue": "comp",
        "Variables": "{\"PBS_O_SHELL\":\"/bin/bash\", \t\"PBS_O_HOST\":\"manager\", \t\"PBS_O_SYSTEM\":\"Linux\", \t\"PBS_O_LANG\":\"en_US.UTF-8\", \t\"PBS_O_QUEUE\":\"workq\"}",
        "Resources": {
          "Nodes": "3",
          "Cores": "6",
          "Memory": "1536MB",
          "Gpus": "0"
        },
        "ArrayJobId": "4",
        "ArrayJobSubId": "1",
        "ResourcesActualOccupied": {
          "Nodes": "2",
          "Cores": "4",
          "Memory": "982MB",
          "Gpus": "0"
        },
        "StartTime": "1724122486"
      }
    }
  ]
}

    錯誤碼

    HTTP status code

    錯誤碼

    錯誤資訊

    描述
    400 InvalidParams The specified parameter %s is invalid. 指定的參數 %s 無效。
    403 InvalidClusterStatus The operation failed due to invalid cluster status. 叢集狀態不允許執行本次操作。
    404 ClusterNotFound The specified cluster does not exist. 指定的叢集不存在，請您檢查該參數是否正確。
    503 ServiceUnavailable The request has failed due to a temporary failure of the server 請求失敗，服務暫時不可用
    406 DbError A database service error occurred. 資料庫請求失敗
    406 EcsError An error occurred while calling the ECS API operation. ECS API調用出錯. %s
    406 AgentError The agent service request failed: %s 操作未成功：%s

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

    變更歷史

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