ListJobs - 查询作业列表_弹性高性能计算(E-HPC)-阿里云帮助中心

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

调试

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

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
ehpc:ListJobs	list	全部资源 ``	无	无

请求参数

名称	类型	必填	描述	示例值
PageSize	integer	否	分页查询时设置的本页条数。默认 50，最大 100。	50
PageNumber	integer	否	当前页码。起始值：1 默认值：1	1
Filter	object	否	查询作业过滤条件。
JobName	string	否	作业名称。支持模糊查询。	testJob
JobId	string	否	作业 ID。	job-xxxx
TimeCreatedAfter	integer	否	在此时间之后提交的作业，以所在地域的时间转化为（国内站为东八区）Unix 时间戳。	1703819914
TimeCreatedBefore	integer	否	在此时间之前提交的作业，以所在地域的时间转化为（国内站为东八区）Unix 时间戳。	1703820113
Status	string	否	作业状态。取值范围： Pending：作业排队中 Initing：作业初始化中 Succeed：作业运行成功 Failed：作业运行失败 Running：作业运行中 Exception：调度异常 Retrying：作业重试中 Expired：作业超时 Suspended：作业休眠 Restarting：作业重启中 Deleted：作业删除完成	Running
SortBy	object	否	排序方式。
Label	string	否	排序标签。取值范围： time_start job_name	time_start
Order	string	否	排序顺序。取值范围： ASC（默认值）：升序 DESC：降序	ASC

返回参数

名称	类型	描述	示例值
	object	Schema of Response
TotalCount	integer	本次请求条件下的数据总量。此参数为可选参数，默认可不返回。	1
RequestId	string	请求 ID。	896D338C-E4F4-41EC-A154-D605E5DE****
PageSize	integer	分页查询时设置的本页条数。	10
PageNumber	integer	当前页码。	1
JobList	array<object>	作业列表。
Job	object	作业列表。
JobName	string	作业名称。	testJob
JobId	string	作业 ID。	job-xxx
JobDescription	string	作业描述。	Demo
CreateTime	string	作业提交时间。	2024-01-25 12:29:21
OwnerUid	string	创建人 UID。	129**********
Status	string	作业状态。可能值： Pending：作业排队中 Initing：作业初始化中 Succeed：作业运行成功 Failed：作业运行失败 Running：作业运行中 Exception：调度异常 Retrying：作业重试中 Expired：作业超时 Deleting：作业删除中 Deleted：作业删除完成	Running
TaskCount	integer	任务数量。	1
ExecutorCount	integer	运行节点数量。	1
StartTime	string	作业开始时间。	2024-01-25 12:29:23
EndTime	string	作业结束时间。	2024-01-25 12:35:23
TaskSustainable	boolean	是否是长时间运行的作业。	true
Tags	array<object>	作业标签列表。
Tag	object	作业标签列表。
TagKey	string	作业标签键。	TestKey
TagValue	string	作业标签值。	TestValue
AppExtraInfo	string	应用附加信息。	{\"xxx\": \"xxxxx\"}

示例

正常返回示例

JSON格式

{
  "TotalCount": 1,
  "RequestId": "896D338C-E4F4-41EC-A154-D605E5DE****",
  "PageSize": 10,
  "PageNumber": 1,
  "JobList": [
    {
      "JobName": "testJob",
      "JobId": "job-xxx",
      "JobDescription": "Demo",
      "CreateTime": "2024-01-25 12:29:21",
      "OwnerUid": "129**********",
      "Status": "Running",
      "TaskCount": 1,
      "ExecutorCount": 1,
      "StartTime": "2024-01-25 12:29:23",
      "EndTime": "2024-01-25 12:35:23",
      "TaskSustainable": true,
      "Tags": [
        {
          "TagKey": "TestKey",
          "TagValue": "TestValue"
        }
      ],
      "AppName": "",
      "AppExtraInfo": "{\\\"xxx\\\": \\\"xxxxx\\\"}"
    }
  ]
}

错误码

HTTP status code	错误码	错误信息	描述
400	InvalidParams	The specified parameter %s is invalid.	无效的参数：%s
400	InDebt	Your account has overdue payments.	您的账户已欠费
400	NotEnabled	You have not enabled this service.	您的账户还未开通此服务
406	AliyunError	An Alibaba Cloud product error occurred.	阿里云产品错误. %s
406	DbError	A database error occurred.	数据库错误
503	ServiceUnavailable	The request has failed due to a temporary failure of the server.	请求失败，服务暂时不可用

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

变更历史

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