Page History

Sv translation

language	en

Module summary

Audit module is the most important module, it provides user management, licensing and auditing services to the other modules. It automatically recognizes other modules, that are running on the same machine or on different servers - either using multicast or IP white list.

Info
Audit module is the main communication channel for the BellaDati IoT console too.

Tip
See Audit configuration to learn more about all configuration options.

Roles

This module supports following roles:

Verticle	Role	Permitted operations
Instance	ADMIN	All operations in all modules
Audit	VIEWER	GET /status, GET /modules, GET /module, GET /sensors

Module states

This module can have one of following statuses:

Verticle	Status	Description
Audit	UP	Module is up and running. It operates without any specific limitations.
Audit	PAUSED	Module is paused but it operates without any specific limitations. Request to "GET /" ends with response code 405.

API endpoints

This module provides following HTTP endpoints:

Path	Method	Description	URL Parameters	Example
/	GET	Returns plain text with ECHO message (should be used in load balancer to detect UP/DOWN status)		https://localhost:8000/
/status	GET	Returns JSON object that contains internal state of audit verticle (e.g. total count of sensors)		https://localhost:8000/status
/modules	GET	Returns JSON array that contains all modules registered in service discovery infrastructure		https://localhost:8000/modules
/module	GET	Returns status and configuration of the module specified by it's name	name = module_name	https://localhost:8000/module?name=Receiver_01
/module	POST	Sets the configuration to the module specified by name. ADMIN role is required.	name = module_name POST body content = config in JSON format	https://localhost:8000/module?name=Receiver_01
/reload	POST	Forces reloading configuration of module specified by name. ADMIN role is required.	name = module_name	https://localhost:8000/reload?name=Receiver_01
/config	POST	Post new config to the module specified by name	name = module_name	https://localhost:8000/config?name=Receiver_01
/logs	GET	Retrieves the current log entries for audit or for specified module	(optional) name = module_name	https://localhost:8000/logs?name=Receiver_01
/sensors	GET	Returns JSON array that contains status of all sensors	order = "ASC" / "DESC" (default: "ASC") start = from timestamp (default: 0) stop = to timestamp receiver_id = receiver identification sensor_id = sensor identification limit = page size (default: 100)	https://localhost:8000/sensors
/pause	GET	Sets status PAUSED for audit verticle immediately. Returns response from "GET /status" endpoint (see above)		https://localhost:8000/pause
/resume	GET	Sets status UP for audit verticle immediately. Returns response from "GET /status" endpoint (see above)		https://localhost:8000/resume
/logout	GET	Executes logout of currently logged in user		https://localhost:8000/logout

On this page

Table of Contents

Sv translation

language	ja

モジュールの概要

Auditモジュールは最も重要なモジュールであり、他のモジュールにユーザー管理、ライセンス、auditing(監査)サービスを提供します。マルチキャストまたはIPホワイトリストを使用して、同じマシンまたは異なるサーバーで実行されている他のモジュールを自動的に認識します。

Info
Auditモジュールは、BellaDati IoTコンソールの主要な通信チャネルでもあります。

Tip
すべての構成オプションの詳細については、 Audit configurationをご覧ください。

ロール

このモジュールは次の役割をサポートします:

Verticle	Role	許可された操作
Instance	ADMIN	すべてのモジュールのすべての操作
Audit	VIEWER	GET /status, GET /modules, GET /module, GET /sensors

モジュールのステータス

このモジュールは、次のいずれかのステータスになります:

Verticle	Status	説明
Audit	UP	モジュールは稼働しています。特定の制限なしで動作します。
Audit	PAUSED	モジュールは一時停止していますが、特定の制限なしで動作しています。 "GET /"へのリクエストは、レスポンスコード405で終了します。

APIエンドポイント

このモジュールは、次のHTTPエンドポイントを提供します:

Path	Method	説明	URLパラメーター	例
/	GET	ECHOメッセージ付きのプレーンテキストを返します (UP/DOWNステータスを検出するためにロードバランサーで使用する必要があります)		https://localhost:8000/
/status	GET	Auditバーティクルの内部ステータス (センサーの合計数など) を含むJSONオブジェクトを返します		https://localhost:8000/status
/modules	GET	サービス検出インフラストラクチャに登録されているすべてのモジュールを含むJSON配列を返します		https://localhost:8000/modules
/module	GET	名前で指定されたモジュールのステータスと構成を返します	name = module_name	https://localhost:8000/module?name=Receiver_01
/module	POST	名前で指定されたモジュールに構成を設定します。ADMINロールが必要です	name = module_name POST body content = config in JSON format	https://localhost:8000/module?name=Receiver_01
/reload	POST	名前で指定されたモジュールの構成を強制的に再読み込みします。 ADMINロールが必要です	name = module_name	https://localhost:8000/reload?name=Receiver_01
/config	POST	名前で指定されたモジュールに新しい構成をポストします	name = module_name	https://localhost:8000/config?name=Receiver_01
/logs	GET	Auditまたは指定されたモジュールの現在のログエントリを取得します	(optional) name = module_name	https://localhost:8000/logs?name=Receiver_01
/sensors	GET	すべてのセンサーのステータスを含むJSON配列を返します	order = "ASC" / "DESC" (default: "ASC") start = from timestamp (default: 0) stop = to timestamp receiver_id = receiver identification sensor_id = sensor identification limit = page size (default: 100)	https://localhost:8000/sensors
/pause	GET	Auditバーティクルのステータスを直ちにPAUSEDに設定します。"GET /status"エンドポイントから応答を返します (上記を参照)		https://localhost:8000/pause
/resume	GET	Auditバーティクルのステータスを直ちにUPに設定します。"GET /status"エンドポイントから応答を返します (上記を参照)		https://localhost:8000/resume
/logout	GET	現在ログインしているユーザーのログアウトを実行します		https://localhost:8000/logout

このページでは

Table of Contents

Page tree

Versions Compared

Old Version 19

New Version Current

Key