通过ListJobs API查询指定集群的作业列表-弹性高性能计算-阿里云

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

调试

您可以在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>	作业列表。
Job	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",
          "PBS_O_HOST": "manager",
          "PBS_O_SYSTEM": "Linux",
          "PBS_O_LANG": "en_US.UTF-8",
          "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.	指定的集群不存在，请您检查该参数是否正确。
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
503	ServiceUnavailable	The request has failed due to a temporary failure of the server	请求失败，服务暂时不可用

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

变更历史

变更时间	变更内容概要	操作
2024-12-09	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情
2024-09-13	OpenAPI 错误码发生变更	查看变更详情