KVS(キー・バリュー形式) APIガイド (v1.2)

GIIPプラットフォームの柔軟なデータストアであるKVS(Key-Value Store)を通じて、インフラのステータスデータ(factor)を照会し、記録するためのAPIを提供します。

🔌 KVS リストページへ →

📋 概要

KVS APIは、エージェントが収集したパフォーマンスメトリクス、インベントリ情報、プロセスリストなど、多様な時系列データおよび定型データを効率的に抽出するために使用されます。

🔐 認証とセキュリティ

• Header: x-giip-ak / x-giip-sk ヘッダーに基づいた認証を実行

📡 API詳細

1. 最新データの照会 (KVSFactorLast)

• コマンド:

  text=KVSFactorLast <factorType>, <lssn>, <factor>

• 例:

  text=KVSFactorLast netinv, 100, netinv

• 説明: 特定のソース(

  lssn

  または

  kKey

  )に対して、指定された

  factor

  の最新の記録1件を返します。

2. 履歴リストの照会 (KVSFactorList)

• コマンド:

  text=KVSFactorList <factorType>, <lssn>, <factor>

• 例:

  text=KVSFactorList lssn, 12345, *

• 説明: 特定の条件に一致するfactorデータの履歴をリスト形式で返します。

🛡️ Sk3(高性能ロギング)の活用

ネットワークトポロジーデータ(

netstat

)やインベントリ情報(

netinv

)のような重要なKVSステータスデータを記録したり、大量に照会したりする場合、

giipApiSk3

エンドポイントを推奨します。

• エンドポイント:

  https://giipfaw.azurewebsites.net/api/giipApiSk3

• 利点: 大量の

  jsondata

  転送時のデータ損失を防止し、記録失敗時にエージェントの詳細なエラーログ(StackTrace)を併せて保存することで、整合性の確保に有利です。
• 活用チップ:

  KVSPut

  コマンドの使用時、

  jsondata

  内に

  kType

  ,

  kKey

  ,

  kFactor

  ,

  kValue

  フィールドを含めると、Sk3エンジンがこれを自動的にマッピングし、より安定的にDBに記録します。

---

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

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

---

関連ドキュメント:

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