使用ListJobs分页排序并按条件查询任务列表-人工智能平台 PAI-阿里云-人工智能平台 PAI(PAI)-阿里云帮助中心

获取任务列表，支持分页、排序和按条件过滤。

调试

您可以在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。如何获取工作空间 ID，请参见 ListWorkspaces 。	1****
ResourceId	string	否	资源组 ID。如何查询专有资源组 ID，详情请参见管理资源配额。	r*****
BusinessUserId	string	否	任务关联用户 ID。	16****
Caller	string	否	调用方。	local
Tags	object	否	用于过滤的标签。
	string	否	单个标签。	recommandation
PipelineId	string	否	过滤指定工作流 ID 创建的任务。	flow-*******
FromAllWorkspaces	boolean	否	是否跨工作空间获取任务列表，需要配合`ShowOwn=true`参数使用，可以查询当前用户最近提交的任务列表。	false
JobId	string	否	任务 ID，不支持模糊查询，对大小写不敏感。不支持通配符。默认为空，代表任意任务 ID。	dlc********
UserIdForFilter	string	否	按任务提交者的用户 ID，过滤查询任务列表。	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
Description	string	否

返回参数

名称	类型	描述	示例值
	object	任务列表。
Jobs	array	任务列表。
	JobItem	单个任务。
TotalCount	integer	符合过滤条件的总任务数。	1
RequestId	string	请求 ID，用于诊断和答疑。	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

错误码

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

变更历史

更多信息，参考变更详情。