跳转至

获取工作流运行的jobs列表

GET /api/v8/repos/{owner}/{repo}/actions/runs/{run_id}/jobs

用户调用此接口,获取指定工作流运行的 jobs 列表。

访问令牌支持说明

  • AtomGit 用户访问令牌(AtomGit user access tokens)

是否允许匿名访问

此接口允许匿名访问

请求参数

参数名 位置 类型 必填 说明
owner path string 是 仓库所属空间地址(组织或个人的地址path)
repo path string 是 仓库路径(path)
run_id path string 是 流水线运行id

响应参数

字段 类型 必返 可为空 说明
total_count integer 是 否 任务总数
jobs array 是 否 作业列表

jobs 对象

字段 类型 必返 可为空 说明
jobs.id string 是 否 作业id
jobs.category null 是 是 分类
jobs.sequence integer 是 否 序号
jobs.async null 是 是 是否异步
jobs.name string 是 否 作业名称
jobs.identifier string 是 否 作业标识
jobs.depends_on string[] 是 否 依赖的作业标识列表
jobs.condition string 是 否 执行条件
jobs.resource string 是 否 资源标识
jobs.is_select boolean 是 否 是否可选
jobs.timeout null 是 是 超时时间
jobs.last_dispatch_id string 是 否 最近一次调度id
jobs.execute_cost_time integer 是 否 执行耗时(毫秒)
jobs.status string 是 否 作业状态
jobs.message null 是 是 状态消息
jobs.start_time integer 是 否 开始时间(时间戳)
jobs.end_time integer 是 否 结束时间(时间戳)
jobs.exec_id string 是 否 执行id
jobs.steps array 是 否 步骤列表
jobs.job_type string 是 否 作业类型
jobs.max_parallel null 是 是 最大并行数
jobs.fail_fast null 是 是 是否快速失败
jobs.from null 是 是 来源
jobs.with null 是 是 传入参数
jobs.secrets null 是 是 密钥
jobs.outputs_define null 是 是 输出定义
jobs.concurrency null 是 是 并发控制配置
jobs.timeout_minutes null 是 是 超时分钟数
jobs.continue_on_error null 是 是 出错时是否继续

jobs.steps 对象

字段 类型 必返 可为空 说明
jobs.steps.runtime_attribution null 是 是 运行时归属
jobs.steps.multi_step_editable integer 是 否 多步骤可编辑标识
jobs.steps.official_task_version null 是 是 官方任务版本
jobs.steps.icon_url null 是 是 图标地址
jobs.steps.name string 是 否 步骤名称
jobs.steps.task string 是 否 任务标识
jobs.steps.business_type null 是 是 业务类型
jobs.steps.inputs array 是 否 输入参数列表
jobs.steps.env string[] 是 否 环境变量列表
jobs.steps.sequence integer 是 否 序号
jobs.steps.identifier string 是 否 步骤标识
jobs.steps.endpoint_ids null 是 是 端点id列表
jobs.steps.id string 是 否 步骤id
jobs.steps.job_run_id string 是 否 作业运行id
jobs.steps.last_dispatch_id string 是 否 最近一次调度id
jobs.steps.status string 是 否 步骤状态
jobs.steps.message null 是 是 状态消息
jobs.steps.start_time integer 是 否 开始时间(时间戳)
jobs.steps.end_time integer 是 否 结束时间(时间戳)
jobs.steps.daily_build_number null 是 是 每日构建号
jobs.steps.timeout-minutes null 是 是 超时分钟数
jobs.steps.continue-on-error null 是 是 出错时是否继续

jobs.steps.inputs 对象

字段 类型 必返 可为空 说明
jobs.steps.inputs.key string 是 否 参数键
jobs.steps.inputs.value string 是 否 参数值

失败响应

400 参数错误

{
  "error": "invalid_request",
  "message": "参数 run_id 不能为空",
  "field": "run_id"
}

401 未认证

{
  "error": "unauthorized",
  "message": "缺少或无效的访问令牌"
}

错误字段名以后端实际返回为准,无法确认时以实际响应为准。

HTTP 响应状态码

状态码 说明
200 成功(OK)
304 未修改(Not modified)
401 需要认证(Requires authentication)
403 禁止访问(Forbidden)

请求示例

参数说明

<owner> 替换为仓库所属空间地址(组织或个人的地址 path); <repo> 替换为仓库路径(path); <run_id> 替换为流水线运行 id。 本接口允许匿名访问,无需携带认证信息;如需访问私有数据,也可携带 AtomGit 用户访问令牌。

cURL

curl -X GET 'https://api.atomgit.com/api/v8/repos/<owner>/<repo>/actions/runs/<run_id>/jobs' \
  -H 'Accept: application/json'

JavaScript

// 原生 fetch (Node.js 18+ / 浏览器)
const response = await fetch("https://api.atomgit.com/api/v8/repos/<owner>/<repo>/actions/runs/<run_id>/jobs", {
  headers: {
    "Accept": "application/json",
  },
});

if (!response.ok) {
  throw new Error(`请求失败: ${response.status}`);
}

const data = await response.json();
console.log(data);

Python

import requests

resp = requests.get(
    "https://api.atomgit.com/api/v8/repos/<owner>/<repo>/actions/runs/<run_id>/jobs",
    headers={
        "Accept": "application/json",
    },
    timeout=10,
)
resp.raise_for_status()

print(resp.json())

响应示例

状态码: 200

{
  "total_count": 0,
  "jobs": [
    {
      "id": "string",
      "sequence": 0,
      "name": "string",
      "identifier": "string",
      "depends_on": [
        "string"
      ],
      "condition": "string",
      "resource": "string",
      "is_select": true,
      "last_dispatch_id": "string",
      "execute_cost_time": 0,
      "status": "string",
      "start_time": 0,
      "end_time": 0,
      "exec_id": "string",
      "steps": [
        {
          "multi_step_editable": 0,
          "name": "string",
          "task": "string",
          "inputs": [
            {
              "key": "string",
              "value": "string"
            }
          ],
          "env": [
            "string"
          ],
          "sequence": 0,
          "identifier": "string",
          "id": "string",
          "job_run_id": "string",
          "last_dispatch_id": "string",
          "status": "string",
          "start_time": 0,
          "end_time": 0
        }
      ],
      "job_type": "string"
    }
  ]
}

错误码

错误码 说明
401 未认证或凭证无效(缺少/无效的访问凭证)
400 参数错误或请求无法解析
404 请求路径不存在
405 请求方法不支持
429 请求过于频繁,触发限流
500 系统内部错误

本页原文 Markdown:在 AtomGit 查看·内容源自开源项目 gitcode-dev/atomgit-api-doc