用户列表
1. 接口描述¶
本接口用于查询多个任务实例的概要信息。
- 可以根据任务ID、任务名称、创建时间等相关信息来查询任务的概要信息。过滤信息详细请见 过滤器ListOption。
- 如果参数为空,返回当前用户一定数量(Limit所指定的数量,默认为20)的任务实例。
2. 输入参数¶
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
ListOption.limit | 否 | Number | 返回的最大任务实例数量 |
ListOption.continue | 否 | string | 返回的任务分页起点 |
3. 输出参数¶
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
items | 是 | JobInstances | 任务实例概要信息列表 |
metadata | 是 | Object | 元数据 |
4. 示例¶
示例1 查看任务列表
查看在 default
空间下所有任务实例信息,限制返回结果最多为5项
输入示例
GET http://argon.api.mgtv.com/api/v1/namespaces/default/jobs?listOption.limit=5
输出示例
{
metadata: {},
items: [
{
argoWorkflow: {name: "build-from-job-340a8d77-5c5a-4a15-9ae4-35b30945ef1e-b4p4b",…}
displayName: "整片转码测试任务001",
name: "job-340a8d77-5c5a-4a15-9ae4-35b30945ef1e",
priority: 0,
type: "normal",
inputs: [{id: "1093a922", source: "b68f380f", sourceAnchor: "a4a3cf9d", displayName: "输入片源路径",…},…]
metadata: {clusterName: "default", namespace: "default", uid: "340a8d77-5c5a-4a15-9ae4-35b30945ef1e"},
outputs: [{id: "5fc871fe", source: "b68f380f", sourceAnchor: "19f5a680", displayName: "输出文件路径",…}],
retryOption: {maxRetry: 2, retryInterval: 3000},
workflow: {uid: "e5e4b487-6222-4c05-9ae6-01bc04234bf8"},
},
...
]
}