作业
作业列表。
目前它嵌套在 构建 中。
属性
| 名称 | 类型 | 描述 |
|---|---|---|
| jobs | [作业] | 作业列表。 |
集合项
jobs 数组中的每个条目都具有以下属性
| 名称 | 类型 | 描述 |
|---|---|---|
| id | 整数 | 唯一标识作业的值。 |
| allow_failure | 未知 | 作业的 allow_failure。 |
| number | 字符串 | 仓库构建的递增编号。 |
| state | 字符串 | 作业的当前状态。 |
| started_at | 字符串 | 作业开始时间。 |
| finished_at | 字符串 | 作业结束时间。 |
| build | 构建 | 作业关联的构建。 |
| queue | 字符串 | 作业计划或正在运行的 worker 队列。 |
| repository | 仓库 | 作业所属的 GitHub 用户或组织。 |
| commit | 提交 | 作业关联的提交。 |
| owner | 所有者 | 作业所属的 GitHub 用户或组织。 |
| stage | [阶段] | 作业的阶段。 |
| created_at | 字符串 | 作业创建时间。 |
| updated_at | 字符串 | 作业更新时间。 |
| private | 布尔值 | 作业是否私有。 |
| restarted_at | 未知 | 作业的 restarted_at。 |
| restarted_by | 未知 | 作业的 restarted_by。 |
| vm_size | 未知 | 作业的 vm_size。 |
| config | 对象 | 作业的配置。 |
| log_complete | 未知 | 作业的 log_complete。 |
操作
查找
这将返回属于单个构建的作业列表。
GET
/build/{build.id}/jobs
| 模板变量 | 类型 | 描述 |
|---|---|---|
| build.id | 整数 | 唯一标识构建的值。 |
| 查询参数 | 类型 | 描述 |
|---|---|---|
| include | [字符串] | 要 急切加载 的属性列表。 |
示例GET /build/86601346/jobs
当前用户
这将返回当前用户有权访问的作业列表。
GET
/jobs
| 查询参数 | 类型 | 描述 |
|---|---|---|
| active | 未知 | job.active 的别名job.active. |
| created_by | 未知 | job.active 的别名job.created_by. |
| include | [字符串] | 要 急切加载 的属性列表。 |
| job.active | 未知 | 文档缺失。 |
| job.created_by | 未知 | 文档缺失。 |
| job.state | [字符串] | 按作业的当前状态筛选作业。 |
| limit | 整数 | 响应中包含的作业数量。用于 分页。 |
| offset | 整数 | 在响应中的第一个条目之前要跳过的作业数量。用于 分页。 |
| sort_by | [字符串] | 按其排序作业的属性。用于 分页。 |
| state | [字符串] | job.active 的别名job.state. |
示例GET /jobs?limit=5
可排序id, state, 附加:desc到任何属性以反转顺序。
默认值为id:desc,state.