GitHub Actions 管理 API 指南 (v1.2)

GIIP 平台提供用于管理和监控 GitHub 仓库工作流 (Workflow) 执行历史记录的 API。

🔌 前往 GitHub 集成功能页 →

📋 概述

GitHub Actions 管理 API 用于同步已注册仓库的最新工作流状态，并提供相关数据，以便在发生故障时通过 GIIP 控制台立即查看。

🔐 认证与安全

• 标头 (Header): 必须包含通用的 x-giip-ak / x-giip-sk 标头。
• 令牌 (Token): githubToken 必须使用 GitHub Personal Access Token (Classic 或 Fine-grained)。

📡 API 详情 (Sk3)

1. 查询 GitHub 配置列表 (GitHubConfigsList)

• 命令: text=GitHubConfigsList
• jsondata: {"csn": 123} (可选)
• 说明: 返回按项目分类的 GitHub 联动配置信息。

2. 创建 GitHub 配置 (GitHubConfigCreate)

• 命令: text=GitHubConfigCreate
• jsondata:

{
  "csn": 123,
  "configName": "Backend Repo",
  "repoOwner": "org-name-or-user",
  "repoName": "repo-name",
  "githubToken": "ghp_..."
}

3. 查询工作流执行历史 (GitHubWorkflowRunsList)

• 命令: text=GitHubWorkflowRunsList
• jsondata: {"gcId": 123, "perPage": 20, "status": "all"}
• 说明: 查询特定联动配置 (gcId) 的 GitHub Actions 执行历史。

🛡️ 巧用 Sk3 (高性能日志)

在创建包含 GitHub Personal Access Token 等敏感信息的配置或执行工作流同步操作时，建议使用 giipApiSk3 端点。

• 端点: https://giipfaw.azurewebsites.net/api/giipApiSk3
• 安全优势: 自动记录任何尝试泄露 githubToken 或异常调用的模式；并在发生错误时提供详细的上下文 (Stacktrace)，以便迅速应对。
• 使用技巧: 利用 text 命令和 jsondata 的参数替换功能，在代码层面安全地管理工作流查询条件（如 perPage、status 等）。

故障排除

症状	原因	解决
返回 401 认证错误	缺少通用的 x-giip-ak / x-giip-sk 标头	确认已包含两个认证标头。
工作流执行历史为空	gcId 缺失/错误或 githubToken 权限不足	指定有效的 gcId，并为 PAT 授予 Actions/repo 读取权限。
GitHubConfigCreate 失败	repoOwner/repoName 拼写错误或 githubToken 过期/无效	核对仓库信息及有效的 PAT (Classic/Fine-grained)。
RstVal 错误或 jsondata 解析失败	jsondata 的 JSON 转义/编码错误	将 jsondata 作为有效 JSON 发送，并查阅 API 结果代码指南。

---

版本: 1.3 最后更新: 2026-04-11 源文件: giipv3/public/help/api-github.zh-CN.md

---

相关文档:

• API 结果代码指南 (RstVal)