ListJobs_人工智能平台 PAI - 分布式训练（DLC）_API文档-阿里云OpenAPI开发者门户

流控信息

当前云产品API请求速率暂未透出。

授权信息

当前云产品暂无权限信息透出。

请求语法

GET /api/v1/jobs HTTP/1.1

请求参数

字段名称	字段详情
DisplayNamestring	任务名称，支持模糊查询，大小写不敏感，不支持通配符。展开详情示例值:tf-mnist-test字符长度 <= 1024
JobTypestring	任务类型，可以查询任意任务类型。默认为空，代表所有类型。支持的任务类型如下：展开详情示例值:TFJob参考取值来源: GetJob CreateJob 字符长度 <= 32
Statusstring	任务运行状态，可能值：展开详情示例值:Running字符长度 <= 32
StartTimestring	查询区间的起始时间；使用任务的创建时间来过滤。默认值是当前时间减去 7 天，即：如果 StartTime 与 EndTime 都没有配置时，默认查询最近 7 天的任务列表。示例值:2020-11-08T16:00:00Z
EndTimestring	查询区间的截止时间；使用任务的创建时间来过滤。默认值是当前时刻。示例值:2020-11-09T14:45:00Z
PageNumberinteger<int32>	分页查询，指定当前需要返回的页码，起始值为 1，默认为 1。示例值:1取值 <= 1000
PageSizeinteger<int32>	分页查询中，指定每页返回的任务数量。示例值:50取值 <= 100
SortBystring	返回任务列表的排序字段，枚举型：展开详情示例值:GmtCreateTime
Orderstring	排列顺序，枚举类型：展开详情示例值:desc枚举值:ascdesc
ShowOwnboolean	是否只查询当前用户提交的任务列表。示例值:true
WorkspaceIdstring	工作空间 ID。如何获取工作空间 ID，请参见 ListWorkspaces 。示例值:1****
ResourceIdstring	资源组 ID。如何查询专有资源组 ID，详情请参见管理资源配额。示例值:r*****
BusinessUserIdstring	任务关联用户 ID。示例值:16****
Callerstring	调用方。示例值:local
Tagsmap<string>	用于过滤的标签。
PipelineIdstring	过滤指定工作流 ID 创建的任务。示例值:flow-*******
FromAllWorkspacesboolean	是否跨工作空间获取任务列表，需要配合`ShowOwn=true`参数使用，可以查询当前用户最近提交的任务列表。示例值:false
JobIdstring	任务 ID，不支持模糊查询，对大小写不敏感。不支持通配符。展开详情示例值:dlc********参考取值来源: UpdateJob StopJob CreateJob
UserIdForFilterstring	按任务提交者的用户 ID，过滤查询任务列表。示例值:20**************
Usernamestring	按任务提交者的用户名，过滤查询任务列表。支持模糊查询，不支持通配符。默认为空，表示不过滤用户名。示例值:test***
ResourceQuotaNamestring	按资源配额的名字，过滤查询任务列表。支持模糊匹配，不支持通配符。默认为空，表示不过滤资源配额。示例值:quota***
Accessibilitystring	作业的可见性，取值如下：展开详情示例值:PRIVATE枚举值:PUBLICPRIVATE
OversoldInfostring	闲时资源信息，可能的取值展开详情示例值:ForbiddenQuotaOverSold
PaymentTypestring

返回参数

字段名称	字段详情
Jobsarray<JobItem>	任务列表。
TotalCountinteger<int64>	符合过滤条件的总任务数。注意请注意，该值为 Long 类型，在某些语言中可能存在精度丢失的风险，请小心使用。示例值:2
RequestIdstring	请求 ID，用于诊断和答疑。示例值:473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

返回示例

变更历史

	变更时间	变更内容概要	操作
	2025-01-09	新增请求参数PaymentType
	2024-11-21	新增请求参数OversoldInfo
	2024-04-09	新增请求参数ResourceQuotaName
	2024-01-12	新增请求参数Username
	2023-12-14	新增请求参数UserIdForFilter
	2022-11-29	新增请求参数JobId

ListJobs_人工智能平台 PAI - 分布式训练（DLC）_API文档

流控信息

授权信息

请求语法

请求参数

返回参数

返回示例

变更历史

相关示例