外部アプリケーションから、Avgidea KVS に対してキーと値( JSON 形式)のペアでデータを格納・取得することができます(*1)。API での操作時にはあらかじめ API キーを作成し、アプリケーションやシェルスクリプト等で使用することができます。
% curl -X POST -d '{"accesskey":"<accesskey>", "secret":"<secretkey>", "component":"kvs", "action":"<action>" ... }' https://<endpoint url>
パラメータ
accesskey : アクセスキー
secret:シークレットキー
component : kvs
action : 実行するアクション
endpoint url : API リクエスト送信先 URL
% curl -X POST -d "{\"accesskey\":\"<accesskey>\", \"secret\":\"<secretkey>\", \"component\":\"kvs\", \"action\":\"<action>\" ...}" https://<endpoint url>
注意事項:
Windows 環境下で curl コマンドを使用する場合、左記の例のように二重引用符のみを用いて、JSON データ内ではエスケープします。
コンソールから KVS データソースとして作成したストア一覧を取得することができます。
% curl -X POST -d '{"accesskey":"<accesskey>", "secret":"<secretkey>", "component":"kvs", "action":"stores"}' https://<endpoint url>
{
"data": [
{
"id": "default",
"registeredAt": "2026-01-27T00:23:03.565307Z"
},
{
"id": "kvs1",
"registeredAt": "2026-02-02T05:56:55.891977Z"
},
{
"id": "mystore",
"registeredAt": "2026-01-29T07:39:15.565111Z"
}
],
"status": "success"
}
パラメータ
action : stores
戻り値
data : ストア一覧
status : 処理のステータス
キーと値のペアをストアに投入することができます。
% curl -X POST -d '{"accesskey":"<accesskey>", "secret":"<secretkey>", "component":"kvs", "action":"create","key":"key1","value":{"p1":"str","p2":1,"p3":true,"p4":2.0},"store":"kvs1"}' https://<endpoint url>
{"data":"key1","status":"success"}
パラメータ
action : create
key : エントリのキー。key がすでに存在する場合、エラーが返る。
value : エントリの値(JSON 形式)
store : ストア名(デフォルト default)
戻り値
data : エントリのキー
status : 処理のステータス
% curl -X POST -d '{"accesskey":"<accesskey>", "secret":"<secretkey>", "component":"kvs", "action":"put","key":"key1","value":{"p1":"str","p2":1,"p3":true,"p4":2.0},"store":"kvs1"}' https://<endpoint url>
{"data":"key1","status":"success"}
パラメータ
action : put
key : エントリのキー。key がすでに存在する場合、値を上書きする
value : エントリの値(JSON 形式)
store : ストア名(デフォルト default)
戻り値
data : エントリのキー
status : 処理のステータス
格納済みのキーと値のペアをストアから取得することができます。
% curl -X POST -d '{"accesskey":"<accesskey>", "secret":"<secretkey>", "component":"kvs", "action":"get","key":"key1",store":"kvs1"}' https://<endpoint url>
{
"data": {
"p1": "str",
"p2": 1,
"p3": true,
"p4": 2
},
"status": "success"
}
パラメータ
action : put
key : エントリのキー。key がすでに存在する場合、値を上書きする
value : エントリの値(JSON 形式)
store : ストア名(デフォルト default)
戻り値
data : エントリの値(*2)
status : 処理のステータス
格納済みのキーと値のペアをストアから削除することができます。
% curl -X POST -d '{"accesskey":"<accesskey>", "secret":"<secretkey>", "component":"kvs", "action":"delete","key":"key1",store":"kvs1"}' https://<endpoint url>
{
"data": "Entry deleted",
"status": "success"
}
パラメータ
action : put
key : エントリのキー。key がすでに存在する場合、値を上書きする
value : エントリの値(JSON 形式)
store : ストア名(デフォルト default)
戻り値
data : 処理メッセージ
status : 処理のステータス
格納済みのキーの一覧を取得することができます。
% curl -X POST -d '{"accesskey":"<accesskey>", "secret":"<secretkey>", "component":"kvs", "action":"keys","filter":"key",store":"kvs1"}' https://<endpoint url>
{
"data": [
{
"id": "key1",
"registeredAt": "2026-01-29T07:39:51.000394Z",
"updatedAt": "2026-01-29T07:39:51.000394Z"
}
],
"status": "success"
}
パラメータ
action : keys
store : ストア名(デフォルト default)
filter : キーのフィルタリング(オプション)
戻り値
data : キーの一覧を含む配列
status : 処理のステータス
Note :
*1 KVS の CRUD 実行毎に、クォータとして KVS request が消費されます。
*2 値に含まれる float 型で、1.0 や 2.0 などの整数として表せる浮動小数点数は、自動的に int 型に変換・格納されます。