查询训练任务列表
更新时间：2024-12-27
描述
获取指定资源池的任务列表
- 支持指定队列查询
- 支持按时间正序、倒序排序
- 支持分页
请求结构
Bash
1GET /api/v1/aijobs
2Host:aihc.bj.baidubce.com
3Authorization:authorization string
4ContentType: application/json 请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必须 | 参数位置 | 说明 |
|---|---|---|---|---|
| resourcePoolId | String | 是 | Query 参数 | 标识资源池的唯一标识符 |
| queue | String | 否 | Query 参数 | 参数为空或为all时，输出全量任务列表，不为空时为指定任务列表，默认输出全部 |
| orderBy | String | 否 | Query 参数 | 排序字段，支持createdAt，finishedAt，默认为createdAt |
| order | String | 否 | Query 参数 | 排序方式，可选 [asc, desc]，asc 为升序，desc 为降序，默认值为 desc |
| pageNo | String | 否 | Query 参数 | 请求分页参数，表示第几页 |
| pageSize | String | 否 | Query 参数 | 单页结果数，默认值为10 |
返回头域
除公共头域外，无其他特殊头域。
返回参数
| 参数名称 | 类型 | 说明 |
|---|---|---|
| requestId | String | 请求ID，用于标识每个请求的唯一性 |
| result | Array of JobListResult | 成功请求时的返回结果 |
返回示例
JSON
1{
2 "requestId": "1341d000-533a-4522-b549-3ec24d050cff",
3 "result": {
4 "total": 9,
5 "jobs": [
6 {
7 "jobId": "mpijob-3f19fcd8-7f6f-40c8-9f36-77d1365c8d15",
8 "name": "api-create-mpi-test-2",
9 "resourcePoolId": "cce-6zwnp4zf",
10 "command": "mpirun -x UCX_NET_DEVICES=mlx5_1:1 -x LD_LIBRARY_PATH -x NCCL_IB_DISABLE=0 -x NCCL_DEBUG=INFO /workspace/nccl-tests/build/all_reduce_perf -b 32M -e 1G -f 2 -g 1 -n 200",
11 "createdAt": "2024-07-16T08:33:43Z",
12 "finishedAt": "",
13 "datasources": [
14 {
15 "type": "emptydir",
16 "mountPath": "/dev/shm",
17 "name": "devshm",
18 "options": {
19 "medium": "Memory",
20 "sizeLimit": 10,
21 "readOnly": false
22 }
23 }
24 ],
25 "enableFaultTolerance": false,
26 "labels": [
27 {
28 "key": "aijob.cce.baidubce.com/openapi-jobid",
29 "value": "mpijob-3f19fcd8-7f6f-40c8-9f36-77d1365c8d15"
30 },
31 {
32 "key": "aijob.cce.baidubce.com/ai-user-id",
33 "value": "d3b41668287b45358a8e6d428da3c824"
34 },
35 {
36 "key": "aijob.cce.baidubce.com/ai-user-name",
37 "value": "zhanghuan12"
38 },
39 {
40 "key": "aijob.cce.baidubce.com/create-from-aihcp",
41 "value": "true"
42 },
43 {
44 "key": "aijob.cce.baidubce.com/create-from-aihcp-api",
45 "value": "true"
46 }
47 ],
48 "priority": "normal",
49 "queue": "default",
50 "status": "Created",
51 "image": "registry.baidubce.com/cce-ai-native/pytorch:23.10-py3-nccl-tests",
52 "resources": [
53 {
54 "name": "cpu",
55 "quantity": 1.1
56 },
57 {
58 "name": "rdma/hca",
59 "quantity": 1
60 },
61 {
62 "name": "baidu.com/a100_80g_cgpu",
63 "quantity": 8
64 }
65 ],
66 "enableRDMA": true,
67 "queueingSequence": 1,
68 }
69 ],
70 "orderBy": "createdAt",
71 "order": "desc",
72 "pageNo": 1,
73 "pageSize": 1
74 }
75}