查询工作流Job的Step级日志¶

POST /api/v8/repos/{owner}/{repo}/actions/runs/{run_id}/jobs/{job_id}/logs

用户调用此接口，进行查询工作流 Job 的 Step 级日志操作。

访问令牌支持说明¶

AtomGit 用户访问令牌（AtomGit user access tokens）

是否允许匿名访问¶

此接口不允许匿名访问

请求参数¶

参数名	位置	类型	必填	说明
`owner`	path	string	是	仓库所属空间地址（组织或个人的地址 path）
`repo`	path	string	是	仓库路径（path）
`run_id`	path	string	是	流水线运行 id
`job_id`	path	string	是	任务 id
`access_token`	query	string	是	用户授权码

Request Body:

请求体为 JSON 格式，包含以下字段：

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "step_id": {
      "description": "Step 运行 id",
      "type": "string"
    },
    "offset": {
      "description": "日志起始偏移量，用于增量分页，第一页传 0，正序传入上一次返回的 end_offset，倒序传入上一次返回的 start_offset",
      "type": "integer"
    },
    "limit": {
      "description": "本次返回的日志条数上限",
      "type": "integer"
    },
    "sort": {
      "description": "排序方式（asc/desc）",
      "type": "string",
      "enum": ["asc", "desc"]
    }
  },
  "required": ["step_id", "offset", "limit", "sort"]
}

响应参数¶

字段	类型	必返	可为空	说明
`has_more`	boolean	是	否	是否还有更多日志
`start_offset`	integer	是	否	本次返回日志的起始偏移量
`end_offset`	integer	是	否	本次返回日志的结束偏移量
`log`	string	是	否	日志内容

失败响应¶

400 参数错误

{
  "error": "invalid_request",
  "message": "请求参数错误"
}

401 未认证

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

以上为通用失败响应示例，具体错误字段名以后端实际返回为准。

HTTP 响应状态码¶

状态码	说明
`200`	成功（OK）
`401`	需要认证（Requires authentication）
`403`	禁止访问（Forbidden）
`404`	未找到（Not found）

请求示例¶

参数说明¶

<owner> 替换为仓库所属空间地址（企业、组织或个人的地址 path）；<repo> 替换为仓库路径；<run_id> 替换为流水线运行 id；<job_id> 替换为任务 id；<token> 替换为你的 AtomGit 用户访问令牌。

cURL¶

curl -X POST 'https://api.atomgit.com/api/v8/repos/<owner>/<repo>/actions/runs/<run_id>/jobs/<job_id>/logs?access_token=<token>' \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -d '{
    "step_id": "step_1",
    "offset": 0,
    "limit": 100,
    "sort": "asc"
  }'

JavaScript¶

// 原生 fetch (Node.js 18+ / 浏览器)
const response = await fetch("https://api.atomgit.com/api/v8/repos/<owner>/<repo>/actions/runs/<run_id>/jobs/<job_id>/logs?access_token=<token>", {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    "Accept": "application/json",
  },
  body: JSON.stringify({
    step_id: "step_1",
    offset: 0,
    limit: 100,
    sort: "asc",
  }),
});

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

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

Python¶

import requests

resp = requests.post(
    "https://api.atomgit.com/api/v8/repos/<owner>/<repo>/actions/runs/<run_id>/jobs/<job_id>/logs",
    params={"access_token": "<token>"},
    headers={
        "Content-Type": "application/json",
        "Accept": "application/json",
    },
    json={
        "step_id": "step_1",
        "offset": 0,
        "limit": 100,
        "sort": "asc",
    },
    timeout=10,
)
resp.raise_for_status()

print(resp.json())

响应示例¶

状态码： 200

{
  "has_more": true,
  "start_offset": 0,
  "end_offset": 0,
  "log": "string"
}

错误码¶

错误码	说明
`401`	未认证或凭证无效（缺少/无效的访问凭证）
`403`	禁止访问
`404`	请求路径不存在
`429`	请求过于频繁，触发限流
`500`	系统内部错误

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