查询训练任务列表
更新时间:2025-09-11
描述
获取指定资源池的任务列表
- 支持指定队列查询
- 支持按时间正序、倒序排序
- 支持分页
请求结构
                Bash
                
            
            1POST ?action=DescribeJobs&resourcePoolId=xxxx
2Host:aihc.bj.baidubce.com
3Authorization:authorization string
4ContentType: application/json
5X-API-Version: v2    请求头域
除公共头域外,无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必须 | 参数位置 | 说明 | 
|---|---|---|---|---|
| resourcePoolId | String | 是 | Query 参数 | 标识资源池的唯一标识符 | 
| queueID | String | 否 | Query 参数 | 托管资源池需传入该参数,为队列Id | 
| queue | String | 否 | Body 参数 | 训练任务所属队列,通用资源池须填入队列名称,不填时返回所有。托管资源池须填入队列Id | 
| status | String | 否 | Body 参数 | 基于状态筛选任务 | 
| keywordType | String | 否 | Body 参数 | 筛选关键字类型,当前仅支持name/queueName | 
| keyword | String | 否 | Body 参数 | 关键字值 | 
| orderBy | String | 否 | Body 参数 | 排序字段,支持createdAt,finishedAt,默认为createdAt | 
| order | String | 否 | Body 参数 | 排序方式,可选 [asc, desc],asc 为升序,desc 为降序,默认值为 desc | 
| pageNumber | Number | 否 | Body 参数 | 请求分页参数,表示第几页 | 
| pageSize | Number | 否 | Body 参数 | 单页结果数,默认值为10 | 
返回头域
除公共头域外,无其他特殊头域。
返回参数
| 参数名称 | 类型 | 说明 | 
|---|---|---|
| requestId | String | 请求ID,用于标识每个请求的唯一性 | 
| totalCount | Number | 返回任务总数 | 
| jobs | List<JobItem> | 成功请求时的返回结果 | 
返回示例
                JSON
                
            
            1{
2    "requestId": "9fa12e3c-c62d-4570-b866-bfc5069f4cf3",
3    "totalCount": 3,
4    "jobs": [
5        {
6            "jobId": "job-oeqpsJhwqq3k",
7            "userId": "eca97e148cb74e9683d7b7240829d1ff",
8            "name": "test-training-job-0513",
9            "status": "Scheduled",
10            "createdAt": "2025-05-13T02:18:51Z",
11            "finishedAt": "",
12            "jobType": "pytorch",
13            "resourcePoolId": "cce-cm1jjxrq",
14            "queueId": "default",
15            "jobSpec": {
16                "image": "registry.baidubce.com/aihc-aiak/aiak-megatron:ubuntu20.04-cu11.8-torch1.14.0-py38_v1.2.7.12_release",
17                "imageConfig": {
18                    "username": "",
19                    "password": ""
20                },
21                "replicas": 2,
22                "resources": [],
23                "envs": [
24                    {
25                        "name": "CUDA_DEVICE_MAX_CONNECTIONS",
26                        "value": "1"
27                    },
28                    {
29                        "name": "NCCL_DEBUG",
30                        "value": "INFO"
31                    },
32                    {
33                        "name": "AIHC_JOB_NAME",
34                        "value": "test-training-job-0513"
35                    },
36                    {
37                        "name": "AIHC_TENSORBOARD_LOG_PATH",
38                        "value": ""
39                    }
40                ],
41                "enableRDMA": false,
42                "hostNetwork": false
43            },
44            "command": "sleep 1d",
45            "labels": [
46                {
47                    "key": "aijob.cce.baidubce.com/ai-user-id",
48                    "value": "eca97e148cb74e9683d7b7240829d1ff"
49                },
50                {
51                    "key": "aijob.cce.baidubce.com/ai-user-name",
52                    "value": "root"
53                },
54                {
55                    "key": "aijob.cce.baidubce.com/create-from-aihcp-api",
56                    "value": "true"
57                },
58                {
59                    "key": "aijob.cce.baidubce.com/openapi-jobid",
60                    "value": "job-oeqpsJhwqq3k"
61                }
62            ],
63            "priority": "normal",
64            "dataSources": [],
65            "enableBccl": false,
66            "enableBcclErrorReason": "",
67            "enableFaultTolerant": false,
68            "faultTolerantArgs": "--enable-hang-detection=false --max-num-of-unconditional-retry=0"
69        },
70        {
71            "jobId": "pytorchjob-4ebe6520-fb61-40a4-8001-e36ab6838a00",
72            "userId": "eca97e148cb74e9683d7b7240829d1ff",
73            "name": "mqm-bos-openapi2",
74            "status": "Succeeded",
75            "createdAt": "2025-05-12T12:41:15Z",
76            "finishedAt": "2025-05-12T12:58:04Z",
77            "jobType": "pytorch",
78            "resourcePoolId": "cce-cm1jjxrq",
79            "queueId": "default",
80            "jobSpec": {
81                "image": "registry.baidubce.com/inf-qa/nginx:latest",
82                "imageConfig": {
83                    "username": "",
84                    "password": ""
85                },
86                "replicas": 1,
87                "resources": [],
88                "envs": [
89                    {
90                        "name": "NCCL_DEBUG",
91                        "value": "INFO"
92                    },
93                    {
94                        "name": "env1",
95                        "value": "value1"
96                    },
97                    {
98                        "name": "AIHC_JOB_NAME",
99                        "value": "mqm-bos-openapi2"
100                    },
101                    {
102                        "name": "AIHC_TENSORBOARD_LOG_PATH",
103                        "value": ""
104                    },
105                    {
106                        "name": "CUDA_DEVICE_MAX_CONNECTIONS",
107                        "value": "1"
108                    }
109                ],
110                "enableRDMA": false,
111                "hostNetwork": false
112            },
113            "command": "sleep 1000",
114            "labels": [
115                {
116                    "key": "aijob.cce.baidubce.com/ai-user-id",
117                    "value": "eca97e148cb74e9683d7b7240829d1ff"
118                },
119                {
120                    "key": "aijob.cce.baidubce.com/ai-user-name",
121                    "value": "root"
122                },
123                {
124                    "key": "aijob.cce.baidubce.com/create-from-aihcp-api",
125                    "value": "true"
126                },
127                {
128                    "key": "aijob.cce.baidubce.com/openapi-jobid",
129                    "value": "pytorchjob-4ebe6520-fb61-40a4-8001-e36ab6838a00"
130                },
131                {
132                    "key": "label1",
133                    "value": "value1"
134                },
135                {
136                    "key": "label2",
137                    "value": "value2"
138                }
139            ],
140            "priority": "high",
141            "dataSources": [],
142            "enableBccl": false,
143            "enableBcclErrorReason": "",
144            "enableFaultTolerant": false,
145            "faultTolerantArgs": "--enable-hang-detection=false --max-num-of-unconditional-retry=0"
146        },
147        {
148            "jobId": "pytorchjob-d1409096-04eb-4e68-97dd-898179ab9320",
149            "userId": "819eb20a0402403282ae8f84cde4024d",
150            "name": "mqm-t",
151            "status": "Succeeded",
152            "createdAt": "2025-05-12T12:37:54Z",
153            "finishedAt": "2025-05-12T12:54:47Z",
154            "jobType": "pytorch",
155            "resourcePoolId": "cce-cm1jjxrq",
156            "queueId": "default",
157            "jobSpec": {
158                "image": "registry.baidubce.com/inf-qa/nginx:latest",
159                "imageConfig": {
160                    "username": "",
161                    "password": ""
162                },
163                "replicas": 1,
164                "resources": [
165                    {
166                        "name": "sharedMemory",
167                        "quantity": 10
168                    }
169                ],
170                "envs": [
171                    {
172                        "name": "AIHC_JOB_NAME",
173                        "value": "mqm-t"
174                    },
175                    {
176                        "name": "AIHC_TENSORBOARD_LOG_PATH",
177                        "value": "/output/training_logs"
178                    },
179                    {
180                        "name": "NCCL_IB_DISABLE",
181                        "value": "1"
182                    }
183                ],
184                "enableRDMA": false,
185                "hostNetwork": false
186            },
187            "command": "sleep 1000",
188            "labels": [
189                {
190                    "key": "aijob.cce.baidubce.com/ai-user-id",
191                    "value": "819eb20a0402403282ae8f84cde4024d"
192                },
193                {
194                    "key": "aijob.cce.baidubce.com/ai-user-name",
195                    "value": "maqiming"
196                },
197                {
198                    "key": "aijob.cce.baidubce.com/create-from-aihcp",
199                    "value": "true"
200                },
201                {
202                    "key": "aijob.cce.baidubce.com/openapi-jobid",
203                    "value": "pytorchjob-d1409096-04eb-4e68-97dd-898179ab9320"
204                }
205            ],
206            "priority": "normal",
207            "dataSources": [
208                {
209                    "type": "emptydir",
210                    "mountPath": "/dev/shm",
211                    "name": "devshm",
212                    "options": {
213                        "sizeLimit": 10,
214                        "medium": "Memory",
215                        "readOnly": false
216                    }
217                },
218                {
219                    "type": "pfsl1",
220                    "sourcePath": "/",
221                    "mountPath": "/ds",
222                    "name": "pfs-7xWeAt",
223                    "options": {
224                        "sizeLimit": 0,
225                        "medium": "",
226                        "readOnly": false
227                    }
228                }
229            ],
230            "enableBccl": false,
231            "enableBcclErrorReason": "",
232            "enableFaultTolerant": false,
233            "faultTolerantArgs": "--enable-hang-detection=false --max-num-of-unconditional-retry=0"
234        }
235    ]
236}