获取任务列表，支持分页、排序和按条件过滤。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试授权信息
当前API暂无授权信息透出。
请求语法
GET /api/v1/jobs
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| DisplayName | string | 否 | 任务名称，支持模糊查询，大小写不敏感，不支持通配符。 例如：输入test，可以匹配test-job1、job-test、job-test2或job-Test；但是不能匹配job-t1。 默认为空，代表任意任务名称。 | tf-mnist-test |
| JobType | string | 否 | 任务类型，可以查询任意任务类型。默认为空，代表所有类型。支持的任务类型如下：
| TFJob |
| Status | string | 否 | 任务状态；默认为空，代表任意状态。 | Running |
| StartTime | string | 否 | 查询区间的起始时间；使用任务的创建时间来过滤。 | 2020-11-08T16:00:00Z |
| EndTime | string | 否 | 查询区间的截止时间；使用任务的创建时间来过滤。 | 2020-11-09T14:45:00Z |
| PageNumber | integer | 否 | 分页查询，指定当前需要返回的页码，起始值为1，默认为1。 | 1 |
| PageSize | integer | 否 | 分页查询中，指定每页返回的任务数量。 | 50 |
| SortBy | string | 否 | 返回任务列表的排序字段，枚举型：
| GmtCreateTime |
| Order | string | 否 | 排列顺序，枚举类型：
| desc |
| ShowOwn | boolean | 否 | 是否只查询当前用户提交的任务列表。 | true |
| WorkspaceId | string | 否 | 工作空间ID。如何获取工作空间ID，请参见ListWorkspaces。 | 1**** |
| ResourceId | string | 否 | 资源组ID。如何查询专有资源组ID，详情请参见准备及管理DLC资源组集群。 | r***** |
| BusinessUserId | string | 否 | 任务关联用户ID。 | 16**** |
| Caller | string | 否 | 调用方。 | local |
| Tags | object | 否 | 用于过滤的标签。 | |
| string | 否 | 单个标签。 | recommandation | |
| PipelineId | string | 否 | 过滤指定工作流ID创建的任务。 | flow-******* |
| FromAllWorkspaces | boolean | 否 | 是否跨工作空间获取任务列表，需要配合 | false |
| JobId | string | 否 | 任务ID，不支持模糊查询，对大小写不敏感。不支持通配符。 默认为空，代表任意任务名称。 | dlc******** |
返回参数
示例
正常返回示例
JSON格式
{
"Jobs": [
{
"JobId": "dlc-20210126170216-********",
"JobType": "TFJob",
"DisplayName": "tf-mnist-test",
"UserId": "123456789",
"Status": "Stopped",
"WorkspaceId": "268",
"WorkspaceName": "dlc-workspace",
"ResourceId": "dlc-quota",
"ResourceLevel": "L0",
"ReasonCode": "JobStoppedByUser",
"ReasonMessage": "Job is stopped by user.",
"JobSpecs": [
{
"Type": "Worker",
"Image": "registry-vpc.cn-hangzhou.aliyuncs.com/cloud-dsw/tensorflow:1.12PAI-gpu-py36-cu101-ubuntu18.04",
"ImageConfig": {
"DockerRegistry": "docker****registry.com",
"Username": " username",
"Password": "password",
"Auth": ""
},
"PodCount": 1,
"EcsSpec": "ecs.c6.large",
"ExtraPodSpec": {
"SideCarContainers": [
{
"Name": "data-init",
"Image": "registry.cn-hangzhou.aliyuncs.com/pai-dlc/curl:v1.0.0",
"Command": [
"curl www.aliyun.com"
],
"Args": [
""
],
"WorkingDir": "/root",
"Env": [
{
"Name": "ENABLE_DEBUG",
"Value": "true"
}
],
"Resources": {
"Limits": {
"key": "{'cpu': '1', 'memory': '1000Mi'}"
},
"Requests": {
"key": "{'cpu': '1', 'memory': '1000Mi'}"
}
}
}
],
"InitContainers": [
{
"Name": "data-init",
"Image": "registry.cn-hangzhou.aliyuncs.com/pai-dlc/curl:v1.0.0",
"Command": [
"curl www.aliyun.com"
],
"Args": [
""
],
"WorkingDir": "/root",
"Env": [
{
"Name": "ENABLE_DEBUG",
"Value": "true"
}
],
"Resources": {
"Limits": {
"key": "{'cpu': '1', 'memory': '1000Mi'}"
},
"Requests": {
"key": "{'cpu': '1', 'memory': '1000Mi'}"
}
}
}
],
"PodLabels": {
"key": ""
},
"PodAnnotations": {
"key": ""
},
"SharedVolumeMountPaths": [
"/root/share/"
]
},
"ResourceConfig": {
"CPU": "10",
"GPU": "3",
"Memory": "10Gi",
"SharedMemory": "5Gi",
"GPUType": "Tesla-V100-16G"
},
"UseSpotInstance": false
}
],
"UserCommand": "python /root/code/mnist.py",
"DataSources": [
{
"DataSourceId": "data-20210114104214-********",
"MountPath": "/mnt/data"
}
],
"CodeSource": {
"CodeSourceId": "code-20210111103721-********",
"Branch": "master",
"Commit": "44da109b59f8596152987eaa8f3b2487bb******",
"MountPath": "/mnt/data"
},
"ThirdpartyLibs": [
"numpy==1.16.1"
],
"ThirdpartyLibDir": "/root/code/",
"Envs": {
"key": "ENABLE_DEBUG_MODE"
},
"GmtCreateTime": "2021-01-12T14:35:01Z",
"GmtSubmittedTime": "2021-01-12T14:35:01Z",
"GmtRunningTime": "2021-01-12T14:35:01Z",
"GmtSuccessedTime": "2021-01-12T14:35:01Z",
"GmtStoppedTime": "2021-01-12T14:35:01Z",
"GmtFailedTime": "2021-01-12T14:35:01Z",
"GmtFinishTime": "2021-01-12T15:36:08Z",
"Duration": 3602,
"Settings": {
"BusinessUserId": "16****",
"Caller": "SilkFlow",
"Tags": {
"key": ""
},
"PipelineId": "pid-123456",
"EnableTideResource": true,
"EnableErrorMonitoringInAIMaster": false,
"ErrorMonitoringArgs": "--enable-log-hang-detection true",
"EnableRDMA": true,
"EnableOssAppend": true,
"OversoldType": "AcceptQuotaOverSold",
"AdvancedSettings": {
"test": "test",
"test2": 1
},
"Driver": "535.54.03"
},
"EnabledDebugger": false,
"ResourceName": "my_resource_group",
"Priority": 1,
"SubStatus": "Restarting"
}
],
"TotalCount": 2,
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E"
}错误码
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 | ||||
|---|---|---|---|---|---|---|
| 2022-11-29 | OpenAPI 入参发生变更 | 看变更集 | ||||
|
