33 Web監視

説明

これらのパラメーターと、各ダッシュボードウィジェットフィールドオブジェクトの有効なプロパティ値を使用することで、dashboard.createメソッドおよびdashboard.updateメソッドでWeb監視ウィジェットを設定できます。

ウィジェットのfieldsプロパティは、ダッシュボードの作成または更新時に検証されません。これにより、ユーザーは組み込みウィジェットを変更したり、カスタムウィジェットを作成したりできますが、ウィジェットを誤って作成または更新してしまうリスクも生じます。 Web監視ウィジェットを正常に作成または更新するには、以下の表に記載されているパラメーターの動作を参照してください。

パラメーター

Web監視ウィジェットでサポートされているパラメーターは以下の通りです。

パラメーター		type	name	value
更新間隔		0	rf_rate	0 - 更新なし; 10 - 10秒; 30 - 30秒; 60 - (デフォルト) 1分; 120 - 2分; 600 - 10分; 900 - 15分。
ホストグループ		2	groupids.0	ホストグループのID。注: 複数のホストグループを設定するには、各ホストグループごとにプロパティ名の番号を増やしてダッシュボードウィジェットフィールドオブジェクトを作成してください。このパラメーターは、テンプレートダッシュボードでウィジェットを設定する場合はサポートされません。
	ホストグループ(ウィジェット)	1	groupids._reference	ホストグループのIDの代わりに: `ABCDE._hostgroupids` - 互換性のあるウィジェット（Referenceパラメーターを"`ABCDE`"に設定）をホストグループのデータソースとして設定します。このパラメーターは、テンプレートダッシュボードでウィジェットを設定する場合はサポートされません。
ホストグループの除外		2	exclude_groupids.0	ホストグループのID。注: 複数のホストグループを除外するには、各ホストグループごとにプロパティ名の番号を増やしてダッシュボードウィジェットフィールドオブジェクトを作成してください。このパラメーターは、テンプレートダッシュボードでウィジェットを設定する場合はサポートされません。
ホスト		3	hostids.0	ホストのID。注: 複数のホストを設定するには、各ホストごとにプロパティ名の番号を増やしてダッシュボードウィジェットフィールドオブジェクトを作成してください。複数のホストを指定する場合、ホストグループパラメーターは未設定か、指定したホストが所属するホストグループを少なくとも1つ設定する必要があります。このパラメーターは、テンプレートダッシュボードでウィジェットを設定する場合はサポートされません。
	ホスト(ウィジェット/ダッシュボード)	1	hostids._reference	ホストのIDの代わりに: `DASHBOARD.hostids` - ダッシュボードのホストセレクターをホストのデータソースとして設定します; `ABCDE._hostids` - 互換性のあるウィジェット（Referenceパラメーターを"`ABCDE`"に設定）をホストのデータソースとして設定します。このパラメーターは、テンプレートダッシュボードでウィジェットを設定する場合はサポートされません。
シナリオタグ
	評価タイプ	0	evaltype	0 - (デフォルト) And/Or; 2 - Or。
	タグ名	1	tags.0.tag	任意の文字列値。注: プロパティ名の番号はタグ評価リスト内のタグの順序を参照します。パラメーターの動作: - 必須（シナリオタグを設定する場合）
	演算子	0	tags.0.operator	0 - 含む; 1 - 等しい; 2 - 含まない; 3 - 等しくない; 4 - 存在する; 5 - 存在しない。注: プロパティ名の番号はタグ評価リスト内のタグの順序を参照します。パラメーターの動作: - 必須（シナリオタグを設定する場合）
	タグ値	1	tags.0.value	任意の文字列値。注: プロパティ名の番号はタグ評価リスト内のタグの順序を参照します。パラメーターの動作: - 必須（シナリオタグを設定する場合）
メンテナンス中のホストを表示		0	maintenance	0 - 無効; 1 - (デフォルト) 有効。
Reference		1	reference	5文字からなる任意の文字列値（例: `ABCDE`や`JBPNL`）。この値は、ウィジェットが属するダッシュボード内で一意でなければなりません。パラメーターの動作: - 必須

例

次の例は、Web監視ウィジェットのダッシュボードウィジェットフィールドオブジェクトの設定を説明することだけを目的としています。ダッシュボードの設定の詳細については、dashboard.createを参照してください。

Web監視ウィジェットの設定

ホストグループ"4"のアクティブなWeb監視シナリオのステータス概要を表示するWeb監視ウィジェットを設定します。

リクエスト:

{
           "jsonrpc": "2.0",
           "method": "dashboard.create",
           "params": {
               "name": "My dashboard",
               "display_period": 30,
               "auto_start": 1,
               "pages": [
                   {
                       "widgets": [
                           {
                               "type": "web",
                               "name": "Web monitoring",
                               "x": 0,
                               "y": 0,
                               "width": 18,
                               "height": 3,
                               "view_mode": 0,
                               "fields": [
                                   {
                                       "type": 2,
                                       "name": "groupids.0",
                                       "value": 4
                                   }
                               ]
                           }
                       ]
                   }
               ],
               "userGroups": [
                   {
                       "usrgrpid": 7,
                       "permission": 2
                   }
               ],
               "users": [
                   {
                       "userid": 1,
                       "permission": 3
                   }
               ]
           },
           "id": 1
       }

レスポンス:

{
           "jsonrpc": "2.0",
           "result": {
               "dashboardids": [
                   "3"
               ]
           },
           "id": 1
       }

Documentation

33 Web監視

説明

パラメーター

例

Web監視ウィジェットの設定

参照