AI 助理
备案控制台
文档
输入文档关键字查找
首页 弹性高性能计算 E-HPC NEXT 开发参考 API参考 API目录 作业 ListJobs - 查询作业列表

ListJobs - 查询作业列表

更新时间：
产品详情
相关技术圈
我的收藏

查询指定集群中的作业列表。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

  • 操作：是指具体的权限点。
  • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
  • 资源类型：是指操作中支持授权的资源类型。具体说明如下：
    • 对于必选的资源类型，用背景高亮的方式表示。
    • 对于不支持资源级授权的操作，用全部资源表示。
  • 条件关键字：是指云产品自身定义的条件关键字。
  • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
操作访问级别资源类型条件关键字关联操作
ehpc:ListJobslist
  • 全部资源
    *
    无
无

请求参数

名称类型必填描述示例值
ClusterIdstring是

集群 ID。

您可以通过调用 ListClusters 获取集群 ID。

ehpc-hz-csbua72***
PageNumberstring否

列表的当前页码。

  • 起始值为 1
  • 默认值为 1
1
PageSizestring否

列表分页查询时每页行数。

  • 最大值：50
  • 默认值：10
10
JobFilterobject否

作业过滤信息。

Usersarray否

执行作业的用户列表信息。

string否

执行作业的用户名。支持模糊查询。

可通过调用 ListUsers 获取该集群中的用户名。

testuser1
Queuesarray否

执行作业的队列列表信息。

string否

执行作业的队列名称。支持模糊查询。

comp
Nodesarray否

执行作业的计算节点列表信息。

string否

计算节点主机名。支持模糊查询。

compute000
JobNamestring否

作业名称。支持模糊查询。

testjob
JobStatusstring否

作业状态。取值范围：

  • all：所有状态。
  • finished：已完成。
  • notfinish：未完成。

默认值：all。

all
CreateTimeStartstring否

作业开始时间。格式为 Unix 时间戳，表示从 1970-01-01T00:00:00Z 起所经过的秒数。

1724122486
CreateTimeEndstring否

作业最后更新时间。格式为 Unix 时间戳，表示从 1970-01-01T00:00:00Z 起所经过的秒数。

1724123085
SortByobject否

作业列表排序方式配置。

ExecuteOrderstring否

按照作业执行时间进行排序。取值范围：

  • asc：升序。
  • desc：降序。

默认值：desc。

asc
SubmitOrderstring否

按照作业提交时间进行排序。取值范围：

  • asc：升序。
  • desc：降序。

默认值：desc。

asc
PendOrderstring否

按照作业排队时间进行排序。取值范围：

  • asc：升序。
  • desc：降序。

默认值：desc。

desc

返回参数

名称类型描述示例值
object

返回信息集合。

TotalCountinteger

本次请求条件下的数据总条数。

10
RequestIdstring

请求 ID。

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

当前页码。默认值：1。

1
PageSizeinteger

分页查询时设置的本页条数。默认值：10。

20
Successboolean

执行命令并获取结果的过程是否成功。可能值：

  • true：成功。
  • false：失败。
true
Jobsarray<object>

作业列表。

object

作业信息列表。

JobNamestring

作业名称。

testjob
JobSpecobject

作业配置信息。

Idstring

作业 ID。

12
RunasUserstring

执行该作业的用户名。

testuser1
Commentstring

作业描述信息。

jobDescription
Statestring

作业状态。可能值：（PBS 集群/Slurm 集群）

  • FINISHED/Completed：已完成。
  • RUNNING/Running：运行中。
  • QUEUED/Pending：排队等待。
  • FAILED/Failed：执行失败。
Running
StderrPathstring

错误输出路径。

./Temp
StdoutPathstring

标准输出路径。

./Temp
Prioritystring

处理作业的优先级。取值范围：0~9，取值越大，优先级越高。

0
ArrayRequeststring

队列作业格式。

  • 如果不是队列作业，输出为空。
  • 格式为 X-Y:Z， 最小值 X 是第一个索引，最大值 Y 是最后一个索引，Z 表示步长，例如 2-7:2，表示作业队列包含编号为 2、4、6 的 3 个子作业。
1-5:2
LastModifyTimestring

作业最后更新时间。

1724123085
NodeListstring

运行作业的计算节点列表。

compute[002,005,003]
SubmitTimestring

作业提交时间。

1724122486
JobQueuestring

执行作业的队列名。

comp
Variablesstring

作业的变量列表。

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

作业运行所需资源信息。

Nodesstring

运行作业的计算节点数量。

3
Coresstring

运行作业的 CPU 核数。

6
Memorystring

运行作业的内存大小。

1536MB
Gpusstring

运行作业的 GPU 数量。

0
ArrayJobIdstring

数组作业 ID。

4
ArrayJobSubIdstring

数组子作业 ID。

1

示例

正常返回示例

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"
      }
    }
  ]
}

错误码

HTTP status code错误码错误信息描述
400InvalidParamsThe specified parameter %s is invalid.指定的参数 %s 无效。
403InvalidClusterStatusThe operation failed due to invalid cluster status.集群状态不允许执行本次操作。
404ClusterNotFoundThe specified cluster does not exist.指定的集群不存在，请您检查该参数是否正确。
406DbErrorA database service error occurred.数据库请求失败
406EcsErrorAn error occurred while calling the ECS API operation.ECS API调用出错
406AgentErrorThe agent service request failed: %s操作未成功：%s
503ServiceUnavailableThe request has failed due to a temporary failure of the server请求失败，服务暂时不可用

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2024-09-13OpenAPI 错误码发生变更查看变更详情
上一篇：CreateJob - 创建作业下一篇：GetJobLog - 查询作业输出日志