データベースAPIリファレンス

GIIPプラットフォームに登録されたデータベース資産の情報を照会および監視するためのAPI詳細仕様です。

🔌 データベース管理機能ページへ →

📋 概要

データベースAPIを通じて、GIIPが管理する MariaDB, Azure SQL, MySQLなどのインスタンス情報をプログラム方式で取得できます。すべてのリクエストには、[APIリファレンス概要]で発行されたAK/SKが必要です。

🔍 主要なエンドポイント

1. データベース一覧の照会

登録されたすべてのDBインスタンスの基本情報を取得します。

• URL: GET /database/list
• 主なパラメータ:
  • csn (Integer): 顧客番号によるフィルタリング
  • prj_isn (Integer): 特定プロジェクト所属のDBのみ照会
• レスポンス例:

  {
    "RstVal": 1,
    "Data": [
      { "isn": 101, "db_name": "Prod_DB", "engine": "AzureSQL", "status": "Running" }
    ]
  }

2. DBパフォーマンス指標の照会

特定のDBのリアルタイムまたは過去のパフォーマンスデータを照会します。

• URL: GET /database/metrics
• 必須パラメータ: db_isn (DB固有番号)
• レスポンスデータ: CPU使用率、データ入出力（IOPS）、空き容量など

3. 現在の接続セッションの照会

DBに接続中のリアルタイムセッションリストを取得します。

• URL: GET /database/sessions
• 用途: 特定のIPからの過剰なコネクション発生の有無を確認

🛠️ 活用例 (Python)

import requests

headers = {"x-giip-ak": "YOUR_AK"}
response = requests.get("https://api.giip.io/v3/database/list", headers=headers)
db_list = response.json()["Data"]

for db in db_list:
    print(f"DB: {db['db_name']} | Status: {db['status']}")

🛡️ Sk3（高性能ロギング）の活用

データベース資産データの転送の整合性を保証し、詳細な呼び出し履歴を残すために、 giipApiSk3 エンドポイントを使用することをお勧めします。

• エンドポイント: https://giipfaw.azurewebsites.net/api/giipApiSk3
• 利点: エージェントエラーの自動検出、呼び出し元のIPおよびセッション情報の自動記録、複雑なDBクエリパラメータ伝達の最適化。
• 活用チップ: text コマンドと jsondata を併用することで、フィルタリング条件が多いDBリストの照会やパフォーマンス指標の収集時に、データを損失することなく安全に送信できます。

トラブルシューティング

症状	原因	解決
401認証エラーが返る	x-giip-ak(AK/SK)ヘッダーの欠落または誤り	発行された有効なAK/SKをリクエストヘッダーに含めているか確認します。
/database/metrics のレスポンスが空	必須パラメータ db_isn の欠落	DB固有番号(db_isn)を必ず渡します。
RstVal が1以外の値で返る	csn/prj_isn の形式誤りまたは権限不足	パラメータを整数型で送信し、API結果コードガイドを確認します。
Sk3呼び出し時に jsondata の解析が失敗する	JSONのエスケープ/エンコーディングエラー	jsondata を有効なJSONにエスケープして送信します。

---

バージョン: 1.1 最終更新日: 2026-04-11 ソースファイル: giipv3/public/help/api-database.ja.md

---

関連ドキュメント:

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