调用ListJobs获取任务列表,支持分页、排序和按条件过滤。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求语法
GET /api/v1/jobs?DisplayName=String&JobType=String&Status=String&StartTime=String&EndTime=String&PageNumber=Integer&PageSize=Integer&SortBy=String&Order=String HTTP/1.1
Content-Type:application/json
请求参数
参数名称 | 类型 | 是否必选 | 示例 | 说明 |
---|---|---|---|---|
DisplayName | String | 否 | tf-mnist-test |
任务名称,支持模糊查询,大小写不敏感。不支持通配符。 比如:输入test,可以匹配 test-job1,job-test,job-test2,job-Test;但是不能匹配job-t1。 默认为空,代表任意任务名称。 |
JobType | String | 否 | TFJob |
任务类型,可以查询任意任务类型。默认为空,代码所有类型。 |
Status | String | 否 | Running |
任务状态;默认为空,代表任意状态。 |
StartTime | String | 否 | 2020-11-08T16:00:00Z |
查询区间的起始时间;使用任务的创建时间来过滤。 |
EndTime | String | 否 | 2020-11-09T14:45:00Z |
查询区间的截止时间;使用任务的创建时间来过滤。 |
PageNumber | Integer | 否 | 1 |
分页查询,指定当前需要返回的页码,从1开始往后编号。 |
PageSize | Integer | 否 | 50 |
分页查询中,指定每页返回的数量。 |
SortBy | String | 否 | GmtCreateTime |
返回任务列表的排序字段,枚举型:
|
Order | String | 否 | desc |
排列顺序,枚举类型:
|
响应体语法
HTTP/1.1 200 OK
Content-Type:application/json
{
"Jobs" : [ {
"JobId" : "String",
"JobType" : "String",
"DisplayName" : "String",
"UserId" : "String",
"Status" : "String",
"ReasonCode" : "String",
"ReasonMessage" : "String",
"JobSpecs" : [ {
"Type" : "String",
"Image" : "String",
"PodCount" : Long,
"EcsSpec" : "String"
} ],
"UserCommand" : "String",
"DataSources" : [ {
"DataSourceId" : "String"
} ],
"CodeSource" : {
"CodeSourceId" : "String",
"Branch" : "String",
"Commit" : "String"
},
"ThirdpartyLibs" : [ "String" ],
"ThirdpartyLibDir" : "String",
"GmtCreateTime" : "String",
"GmtFinishTime" : "String",
"Duration" : Long
} ],
"TotalCount" : Long,
"RequestId" : "String"
}
响应参数
参数名称 | 类型 | 示例 | 说明 |
---|---|---|---|
Jobs | Array of JobItem |
任务列表 |
|
TotalCount | Long | 2 |
符合过滤条件的总任务数 |
RequestId | String | 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E |
请求ID,用于诊断和答疑。 |
查询所有停止的任务
GET /api/v1/jobs?Status=Stopped HTTP/1.1
Host:pai-dlc.aliyuncs.com
Content-Type:application/json
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<Jobs>
<JobId>dlc-20210126170216-************</JobId>
<JobType>TFJob</JobType>
<DisplayName>tf-mnist-test</DisplayName>
<UserId>123456789</UserId>
<Status>Stopped</Status>
<ReasonCode>JobStoppedByUser</ReasonCode>
<ReasonMessage>Job is stopped by user.</ReasonMessage>
<JobSpecs>
<Type>Worker</Type>
<Image>registry.cn-hangzhou.aliyuncs.com/pai-dlc/tensorflow-training:1.12.2PAI-cpu-py27-ubuntu16.04</Image>
<PodCount>1</PodCount>
<EcsSpec>ecs.c6.large</EcsSpec>
</JobSpecs>
<UserCommand>python /root/code/mnist.py</UserCommand>
<DataSources>
<DataSourceId>data-20210114104214-************</DataSourceId>
</DataSources>
<CodeSource>
<CodeSourceId>code-20210111103721-************</CodeSourceId>
<Branch>master</Branch>
<Commit>44da109b59f8596152987eaa8f3b2487bb72ea63</Commit>
</CodeSource>
<ThirdpartyLibs>numpy==1.16.1</ThirdpartyLibs>
<ThirdpartyLibDir>/root/code/</ThirdpartyLibDir>
<GmtCreateTime>2021-01-12T14:35:01Z</GmtCreateTime>
<GmtFinishTime>2021-01-12T15:36:08Z</GmtFinishTime>
<Duration>3602</Duration>
</Jobs>
<TotalCount>1</TotalCount>
<RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E</RequestId>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"Jobs" : [ {
"JobId" : "dlc-20210126170216-************",
"JobType" : "TFJob",
"DisplayName" : "tf-mnist-test",
"UserId" : "123456789",
"Status" : "Stopped",
"ReasonCode" : "JobStoppedByUser",
"ReasonMessage" : "Job is stopped by user.",
"JobSpecs" : [ {
"Type" : "Worker",
"Image" : "registry.cn-hangzhou.aliyuncs.com/pai-dlc/tensorflow-training:1.12.2PAI-cpu-py27-ubuntu16.04",
"PodCount" : 1,
"EcsSpec" : "ecs.c6.large"
} ],
"UserCommand" : "python /root/code/mnist.py",
"DataSources" : [ {
"DataSourceId" : "data-20210114104214-************"
} ],
"CodeSource" : {
"CodeSourceId" : "code-20210111103721-************",
"Branch" : "master",
"Commit" : "44da109b59f8596152987eaa8f3b2487bb72ea63"
},
"ThirdpartyLibs" : [ "numpy==1.16.1" ],
"ThirdpartyLibDir" : "/root/code/",
"GmtCreateTime" : "2021-01-12T14:35:01Z",
"GmtFinishTime" : "2021-01-12T15:36:08Z",
"Duration" : 3602
} ],
"TotalCount" : 1,
"RequestId" : "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E"
}
错误码
访问错误中心查看更多错误码。
开发者资源
-
SDK
阿里云为您提供多种语言的SDK,帮助您快速通过API集成阿里云的产品和服务,推荐您使用SDK调用API,已免除您手动签名验证。
-
OpenAPI Explorer
快速检索,可视化调试API,在线命令行工具,同步动态生成可执行的SDK代码示例。
-
阿里云CLI
阿里云资产管理和配置工具,可通过命令方式同时管理多个阿里云产品和服务,简单快捷,是您上云好帮手。
在文档使用中是否遇到以下问题
更多建议
匿名提交