giip

APIリファレンス概要 (v1.2)

GIIPプラットフォームのマイクロサービスおよびデータベースリソースを制御・監視するための共通API規格と認証方式をご案内します。

📋 概要

GIIP APIはRESTfulアーキテクチャの原則に従い、JSON形式を使用してリクエストを処理し、レスポンスを返します。すべてのAPIはセキュリティのためHTTPSプロトコルを通じてのみアクセス可能であり、有効なAccess KeyとSecret Keyを使用することで正常な機能呼び出しが可能になります。

🔐 認証 (Authentication)

すべてのAPIリクエストヘッダーには、以下の認証情報が含まれている必要があります。

Header KeyDescription
x-giip-akGIIP管理者から発行された Access Key
x-giip-skGIIP管理者から発行された Secret Key

[!IMPORTANT] Secret Keyは外部に漏洩してはならず、クライアント側のJavaScript (JS) コードなどに直接露出しないよう、サーバー側で安全に管理する必要があります。

📡 共通レスポンス形式 (Response Format)

GIIPのすべてのAPIは、一貫したレスポンス形式を提供し、クライアント側の処理を容易にします。

{
  "RstVal": 0,
  "RstMsg": "Success",
  "Data": { ... }
}
  • RstVal: 成功の有無 (0: 成功, その他: エラー)
  • RstMsg: 成功メッセージ (エラー発生時は詳細な原因テキストを含む)
  • Data: リクエスト成功時に返されるデータ本文

🚀 リクエスト形式

すべてのAPIリクエストは、Azure Function呼び出し規格に従い、application/x-www-form-urlencodedでPOSTします。

主要なフォームデータ

フィールド説明
text実行するコマンド文字列
user_id呼び出し元のユーザーID
tokenセッショントークン
usertoken実際の連動に使用されるセッショントークン

🚀 APIグループ別ガイド

分野別の詳細なAPI仕様については、以下の個別ガイドを参照してください。

  1. サーバー管理API: インフラ資産の照会およびコマンド実行
  2. データベースAPI: DBパフォーマンスおよびクエリ統計
  3. イシュー管理API: 障害アラームおよびステータス更新
  4. コスト分析API: クラウド使用量およびコスト予測
  5. プロジェクト/ユーザーAPI: 権限および組織管理
  6. モニタリングデータ照会API: リアルタイムCPU/MEM/Diskメトリクス、パフォーマンス履歴、プロセスリスト
  7. ネットワークセキュリティポリシーAPI: ファイアウォールルールの照会、IP許可/遮断、ポリシーの一括適用
  8. ネットワークトポロジー(Net3D)API: インフラ接続データの収集・転送規格 (netinv, netstat, db_connections)
  9. システム管理API: リモートコマンド実行、エージェント制御、サーバータグ管理
  10. KVS(キー・バリュー形式)API: factorデータ照会 (KVSFactorLast, KVSFactorList)
  11. Vercel管理API: Vercel設定管理およびデプロイ履歴の照会
  12. GitHub Actions管理API: GitHubリポジトリ連携およびワークフロー履歴の照会
  13. メールサーバー管理API: SMTPサーバーの設定およびテスト送信 (管理者専用)
  14. Sk3 (高性能ロギング) API: エージェント転送エラーの検知およびデータ整合性検証のためのHigh-fidelityロギングブリッジ
  15. 共通レスポンスおよび結果コードガイド (RstVal): tDefRstテーブルに基づいた標準結果コードの案内

🛠️ 共通エラーコード

  • 401 Unauthorized: 認証情報が無効か期限切れの場合
  • 403 Forbidden: 当該APIを呼び出す権限がない場合（IPベースのアクセス制御を含む）
  • 429 Too Many Requests: リクエスト頻度制限(Rate Limit)を超過した場合
  • 500 Internal Server Error: サーバー内部エラーおよび一時的な障害が発生した場合

📖 開発者の注意事項

  • エンドポイント呼び出し部: src/lib/lsvrUtils.ts
  • セッション管理: sessionStorageの user_id、token、csn、cnameなどを参照
  • すべての連携はHTTPSを基本とします。

🔧 トラブルシューティング

症状原因解決方法
401 Unauthorized が返されるAccess Key/Secret Key が期限切れか無効であるx-giip-ak/x-giip-sk ヘッダーの値を再確認し、必要に応じて管理者にキーの再発行を依頼します
403 Forbidden が返される当該 API の呼び出し権限がない、または IP ベースのアクセス制御でブロックされているアカウント権限と送信元 IP が許可されているかを確認します
RstVal が0以外だが原因が分からない標準結果コードの意味を確認していないRstMsg を確認し、API結果コードガイド で該当コードを照会します
リクエストが処理されない、または text コマンドが無視されるリクエストが application/x-www-form-urlencoded 形式でない、または text/user_id/token フィールドが欠落している規格に従い、必須フィールドを含むフォームデータを正しい形式で送信します

バージョン: 1.2 最終更新日: 2026-04-11 マークダウン原文: giipv3/public/help/api-reference.ja.md

← PreviousAPI結果コード (RstVal)Next →Sk3 高性能ロギングAPI