30のトップトリガー

説明

これらのパラメータと、各ダッシュボードウィジェットフィールドオブジェクトの可能なプロパティ値により、dashboard.createおよびdashboard.updateメソッドでトリガートップウィジェットを設定できます。

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

パラメーター

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

パラメーター type name value
リフレッシュ間隔 0 rf_rate 0 - (デフォルト) リフレッシュなし;
10 - 10秒;
30 - 30秒;
60 - 1分;
120 - 2分;
600 - 10分;
900 - 15分。
ホストグループ 2 groupids.0 ホストグループのID。

注: 複数のホストグループを設定するには、プロパティ名の番号を増やして各ホストグループごとにダッシュボードウィジェットフィールドオブジェクトを作成します。

このパラメーターは、テンプレートダッシュボードでウィジェットを設定する場合はサポートされません。
ホスト 3 hostids.0 ホストのID。

注: 複数のホストを設定するには、プロパティ名の番号を増やして各ホストごとにダッシュボードウィジェットフィールドオブジェクトを作成します。複数のホストを指定する場合、ホストグループパラメーターは未設定であるか、または設定したホストが属する少なくとも1つのホストグループで設定する必要があります。

このパラメーターは、テンプレートダッシュボードでウィジェットを設定する場合はサポートされません。
障害 1 problem 障害イベント名(大文字小文字を区別しない、完全一致または部分一致)。
深刻度 0 severities.0 トリガーの深刻度。

0 - 未分類;
1 - 情報;
2 - 警告;
3 - 軽度障害;
4 - 障害;
5 - 重度障害。

デフォルト: 空(すべて有効)。

注: 複数の値を設定するには、プロパティ名の番号を増やして各値ごとにダッシュボードウィジェットフィールドオブジェクトを作成します。
障害タグ
評価タイプ 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 任意の文字列値。

注: プロパティ名の番号は、タグ評価リスト内のタグの順序を参照します。

パラメーターの動作:
- 障害タグを設定する場合は必須
期間 1 time_period._reference DASHBOARD._timeperiod - ダッシュボードの期間セレクターをデータソースとして設定;
ABCDE._timeperiod - 互換性のあるウィジェット参照パラメーターを"ABCDE"に設定)をデータソースとして設定。

デフォルト: DASHBOARD._timeperiod

または、FromおよびToパラメーターで期間のみを設定することもできます。
From 1 time_period.from 絶対(YYYY-MM-DD hh:mm:ss)または相対時間構文(nownow/dnow/w-1wなど)での有効な時間文字列。

パラメーターの動作:
- 期間が設定されていない場合にサポート
- time_period.toが設定されている場合は必須
To 1 time_period.to 絶対(YYYY-MM-DD hh:mm:ss)または相対時間構文(nownow/dnow/w-1wなど)での有効な時間文字列。

パラメーターの動作:
- 期間が設定されていない場合にサポート
- time_period.fromが設定されている場合は必須
トリガーの表示数 0 show_lines 1-100の範囲で指定可能。

デフォルト: 10。

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

Top triggersウィジェットの設定

ホストグループ「4」のトリガーのうち、各トリガーのすべての障害の数をカウントして上位5件を表示するTop triggersウィジェットを設定します。 このウィジェットは、「Warning」「Average」「High」「Disaster」の深刻度を持つトリガーのみを表示し、タグ名「scope」に「performance」「availability」「capacity」のいずれかの値を含むタグを持つ障害のみを表示します。

リクエスト:

{
    "jsonrpc": "2.0",
    "method": "dashboard.create",
    "params": {
        "name": "My dashboard",
        "display_period": 30,
        "auto_start": 1,
        "pages": [
            {
                "widgets": [
                    {
                        "type": "toptriggers",
                        "name": "Top triggers",
                        "x": 0,
                        "y": 0,
                        "width": 36,
                        "height": 5,
                        "view_mode": 0,
                        "fields": [
                            {
                                "type": 2,
                                "name": "groupids.0",
                                "value": 4
                            },
                            {
                                "type": 0,
                                "name": "severities.0",
                                "value": 2
                            },
                            {
                                "type": 0,
                                "name": "severities.1",
                                "value": 3
                            },
                            {
                                "type": 0,
                                "name": "severities.2",
                                "value": 4
                            },
                            {
                                "type": 0,
                                "name": "severities.3",
                                "value": 5
                            },
                            {
                                "type": 1,
                                "name": "tags.0.tag",
                                "value": "scope"
                            },
                            {
                                "type": 0,
                                "name": "tags.0.operator",
                                "value": 0
                            },
                            {
                                "type": 1,
                                "name": "tags.0.value",
                                "value": "performance"
                            },
                            {
                                "type": 1,
                                "name": "tags.1.tag",
                                "value": "scope"
                            },
                            {
                                "type": 0,
                                "name": "tags.1.operator",
                                "value": 0
                            },
                            {
                                "type": 1,
                                "name": "tags.1.value",
                                "value": "availability"
                            },
                            {
                                "type": 1,
                                "name": "tags.2.tag",
                                "value": "scope"
                            },
                            {
                                "type": 0,
                                "name": "tags.2.operator",
                                "value": 0
                            },
                            {
                                "type": 1,
                                "name": "tags.2.value",
                                "value": "capacity"
                            },
                            {
                                "type": 0,
                                "name": "show_lines",
                                "value": 5
                            }
                        ]
                    }
                ]
            }
        ],
        "userGroups": [
            {
                "usrgrpid": 7,
                "permission": 2
            }
        ],
        "users": [
            {
                "userid": 1,
                "permission": 3
            }
        ]
    },
    "id": 1
}

レスポンス:

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

参照