1.2.1. config.json¶

Backend APIの動作に関する設定ファイルです。

/opt/nec/pf/ice/config/backendapi{バージョン}.config.json

設定可能な項目は以下の通りです。

mongodb

url

MongoDBに接続するためのURL文字列です。認証情報やコネクションの設定などを定義可能です。

詳細はMongoDBのマニュアルを参照してください。

既定値：mongodb://%7Bhost%7D:{port}/rawdata?maxPoolSize=100&connectTimeoutMS=10000&socketTimeoutMS=10000
reconnectInterval

MongoDBとの接続が切断された場合に、再接続を試行する間隔をミリ秒で設定します。

既定値：1000

collections

Backend APIが使用するコレクションを設定します。以下のフィールドについて設定します。

フィールド	説明
edgeInfo	エッジのメタデータを格納するコレクションを設定します。
objectInfo	オブジェクトのメタデータを格納するコレクションを設定します。
eventData	イベントデータを格納するコレクションを設定します。コレクション分割機能を有効化している場合、ここで設定したコレクションがデフォルトのコレクションになります。
opInfo	オペレーションのメタデータを格納するコレクションを設定します。
opResult	オペレーション実行結果を格納するコレクションを設定します。
fileInfo	ファイルのメタデータお格納するコレクションを設定します。
maEventData	管理アプリケーションのイベントデータを格納するコレクションを設定します。コレクション分割機能を有効化している場合、ここで設定したコレクションがデフォルトのコレクションになります。
maOpInfo	管理アプリケーションに向けて実行したオペレーションのメタデータを格納するコレクションを設定します。
maOpResult	管理アプリケーションに向けて実行したオペレーションの実行結果を格納するコレクションを設定します。

opInfo、fileInfo、maOpInfo以外のフィールドは、ICE Message Routerのルールファイルの定義に合うように値を設定する必要があります。

既定値：

{
    "edgeInfo": "edge_info",
    "objectInfo": "object_info",
    "eventData": "event_data",
    "opInfo": "op_info",
    "opResult": "op_result",
    "fileInfo": "file_info",
    "maEventData": "ma_event_data",
    "maOpInfo": "ma_op_info",
    "maOpResult": "ma_op_result"
}

collectionPartitioning

イベントデータのコレクション分割機能の設定を行います。eventDataが管理アプリケーション以外のイベントデータ、maEventDataが管理アプリケーションのイベントデータに対応します。

enabledがtrueの時、機能が有効化します。partitionsに、”{パーティション名}”:”{コレクション名}”というJSON形式で分割設定を記述します。

既定値：
```
{
    "eventData":{
        "enabled": false,
        "partitions": {
        }
    },
    "maEventData":{
        "enabled": false,
        "partitions": {
        }
    }
}
```

mqtt

options

MQTT Brokerに接続する際のオプションを設定します。接続先情報や、ユーザ名、パスワードを含みます。

既定値：

{
    "servers": [
        {
            "host": "localhost",
            "port": 1883
        }
    ],
    "username": "iotuser",
    "password": "iotuser",
    "queueQosZero": false,
    "clientId": "ICE_Backend_API"
}

fileDelivery

baseUrl

ファイル配信に使用するダウンロード用URLです。

既定値：http://localhost:80/fileserver/
destDir

ファイル配信のファイル保存ディレクトリです。

既定値：/var/www/html
enableDeleteAll

ファイル全削除のAPI(DELETE /backend/file/delivery)を有効化するかどうかの設定です。

falseの場合、API実行時にステータスコード405のエラーメッセージが返却されます。

既定値：false

fileCollection

destDir

ファイル集信のファイル保存ディレクトリです。

既定値：/var/lib/ice

swagger

port

Backend APIのリクエスト受付ポート番号を設定します。

既定値：22401