GitHub Actions管理APIガイド (v1.2)

GIIPプラットフォームは、GitHubリポジトリのワークフロー実行履歴を管理し、モニタリングするための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など)をコードレベルで安全に管理してください。

---

バージョン: 1.3 最終更新日: 2026-04-11 ソースファイル:

giipv3/public/help/api-github.ja.md

---

関連ドキュメント:

• API結果コードガイド (RstVal)