プロベナンス: 構成情報

当ドキュメントでは、構成情報に関して記述しています。 機能により、構成情報を参照することがあります。

実行方式は全て JSON-RPC v2.0 を利用します。

prov.get_configs

設定を確認します。システム上非公開とする値は取得されません。

JSON-RPCのリクエスト例は下記の通りです。

{
  "jsonrpc": "2.0",
  "method": "prov.get_configs",
  "params": {},
  "id": "provenance_jsonrpc_id"
}

実行結果は構成に関するキーとバリューの列挙型（辞書）を返します。

{
  "id": "provenance_jsonrpc_id",
  "jsonrpc": "2.0",
  "result": {
    "TENANT_ID": "xxx",
    "TENANT_VERSION": "1.0"
  }
}

パラメータ

指定できるパラメータはありません。

prov.patch_config

システム上編集可能な設定を変更します。

JSON-RPCのリクエスト例は下記の通りです。

{
  "jsonrpc": "2.0",
  "method": "prov.patch_config",
  "params": {
    "key": "TARGET_KEY",
    "value": "VALUE"
  },
  "id": "provenance_jsonrpc_id"
}

実行結果例は下記の通りです。

{
  "id": "provenance_jsonrpc_id",
  "jsonrpc": "2.0",
  "result": {
    "key": "xxx",
    "value": "xxx",
    "is_public": "xxx",
    "description": "xxx",
    "created_at": "2020-01-01T00:00:00+00:00",
    "updated_at": "2021-01-01T00:00:00+00:00"
  }
}

パラメータ

params には以下のパラメータを指定します。

パラメータ名	データ型	内容	既定値
key	string	変数名（大文字）	必須
value	string	設定値	必須