イシュー管理 API リファレンス
GIIPプラットフォームで発生するシステムイシュー、アラーム、およびユーザーからの問い合わせ(チケット)をプログラミング方式で管理するためのAPI詳細仕様です。
📋 概要
イシュー管理APIは、インフラ障害発生時に外部コラボレーションツール(Jira、Slackなど)と連携したり、独自の障害処理ワークフローを自動化したりするために使用されます。
🔍 主要エンドポイント
1. イシュー一覧照会
発生したすべてのイシューおよび警告アラームの一覧を取得します。
- URL:
GET /issue/list - 主要パラメータ:
(String):level
,Critical
,Warning
でフィルタリングInfo
(String):status
,Open
,In_Progress
などの状態を照会Done
- レスポンスデータ: イシュータイトル、発生日時、対象サーバー(
)、詳細内容などserver_isn
2. 新規イシュー/チケット作成
ユーザーが直接イシューを登録したり、外部モニタリングシステムのアラームをGIIPに記録したりします。
- URL:
POST /issue/create - ペイロード:
: イシュータイトルtitle
: 詳細内容content
: 関連サーバー番号 (任意)server_isn
- レスポンス: 生成されたイシュー固有番号(
)を返却issue_isn
3. イシュー状態更新
イシューの処理状態を変更したり、担当者を指定したりします。
- URL:
PUT /issue/update - ペイロード:
: 対象イシュー番号issue_isn
: 変更する状態 (例:status
)Done
: 処理内容の記録comment
🛠️ 活用例 (Python)
import requests # 'Open' 状態のクリティカルイシューを照会 params = {"level": "Critical", "status": "Open"} headers = {"x-giip-ak": "YOUR_AK"} response = requests.get("https://api.giip.io/v3/issue/list", headers=headers, params=params) for issue in response.json()["Data"]: print(f"🚨 [{issue['level']}] {issue['title']} (Server ID: {issue['server_isn']})")
🛡️ Sk3 (高信頼性ロギング) の活用
障害対応ワークフローの自動化時、イシュー状態更新の整合性確保と詳細なエラーコンテキスト収集のために
giipApiSk3 エンドポイントを推奨します。
- エンドポイント:
https://giipfaw.azurewebsites.net/api/giipApiSk3 - メリット: イシュー更新失敗時に呼び出し元の詳細なメタデータとStackTraceを自動記録し、原因把握を容易にします。
- 活用チップ: 外部モニタリングシステム(Prometheus、Zabbixなど)からGIIPにイシューを送信する際にSk3エンドポイントを使用すると、データ消失やネットワーク遅延によるエラー状況をより明確に追跡できます。
バージョン: 1.1 最終更新: 2026-04-10 ソースファイル:
giipv3/public/help/giip-issue-api.ja.md
関連ドキュメント: