1.0.1 • Published 5 years ago
node-red-contrib-sakura-io-datastore-api v1.0.1
node-red-contrib-sakura-io-datastore-api
Node-RED node for sakura-io-datastore-api
モジュールからデータを蓄積するサービスです。 定期的に処理を行うバッチ処理などでご利用頂けます。
APIを使用するにあたって
データの取得単位
DataStoreのAPIには大きく2つのAPIが存在しています。
/messages
APIではチャンネルのデータ以外の情報も取得可能です。
API | 用途 |
---|---|
/channels | チャンネル毎のデータを取得する |
/messages | チャンネルのデータや、モジュールUP/DOWN等のデータも取得する |
大量のデータを取得する方法
データを取得すると、 meta
オブジェクトの cursor
フィールドにカーソルが返されます。
そのカーソルをリクエストする際に cursor
パラメータとして指定することで、
次のレスポンスを取得できます。
その他注意事項
- モジュールからデータを送信しても反映されるまで時間が掛る場合が有ります。通常は数秒程度で反映されます。
- サービスを削除してもデータは削除されません。全てのモジュールからのデータを蓄積しています。
- レスポンスの
id
フィールドは、サービス側で予告なしに形式が変更される場合があります。
Install
Run the following command in your Node-RED user directory - typically ~/.node-red
npm install node-red-contrib-sakura-io-datastore-api
Usage
Methods
getV1Channels
チャンネルのデータを取得します
getV1Messages
チャンネルのデータの他、モジュールが接続された時のメッセージなどを取得します
1.0.1
5 years ago