giip

イシュー管理 API リファレンス

GIIPプラットフォームで発生するシステムイシュー、アラーム、およびユーザーからの問い合わせ(チケット)をプログラミング方式で管理するためのAPI詳細仕様です。

🔌 イシュー管理機能ページへ →

📋 概要

イシュー管理APIは、インフラ障害発生時に外部コラボレーションツール(Jira、Slackなど)と連携したり、独自の障害処理ワークフローを自動化したりするために使用されます。

🔍 主要エンドポイント

1. イシュー一覧照会

発生したすべてのイシューおよび警告アラームの一覧を取得します。

  • URL:
    GET /issue/list
  • 主要パラメータ:
    • level
      (String):
      Critical
      ,
      Warning
      ,
      Info
      でフィルタリング
    • status
      (String):
      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


関連ドキュメント: