[comment]: # ({898d1f65-41e9cb8c})
# 30のトップトリガー

[comment]: # ({/898d1f65-41e9cb8c})

[comment]: # ({7e740a18-30595671})
### 説明

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

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

[comment]: # ({/7e740a18-30595671})

[comment]: # ({27da08e4-b5e67e19})
### パラメーター

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

|パラメーター|<|[type](/manual/api/reference/dashboard/object#dashboard-widget-field)|name|value|
|-|--------|--|--------|-------------------------------|
|*リフレッシュ間隔*|<|0|rf_rate|0 - *(デフォルト)* リフレッシュなし;<br>10 - 10秒;<br>30 - 30秒;<br>60 - 1分;<br>120 - 2分;<br>600 - 10分;<br>900 - 15分。|
|*ホストグループ*|<|2|groupids.0|[ホストグループ](/manual/api/reference/hostgroup/get)のID。<br><br>注: 複数のホストグループを設定するには、プロパティ名の番号を増やして各ホストグループごとにダッシュボードウィジェットフィールドオブジェクトを作成します。<br><br>このパラメーターは、[テンプレートダッシュボード](/manual/api/reference/templatedashboard/object)でウィジェットを設定する場合はサポートされません。|
|*ホスト*|<|3|hostids.0|[ホスト](/manual/api/reference/host/get)のID。<br><br>注: 複数のホストを設定するには、プロパティ名の番号を増やして各ホストごとにダッシュボードウィジェットフィールドオブジェクトを作成します。複数のホストを指定する場合、*ホストグループ*パラメーターは未設定であるか、または設定したホストが属する少なくとも1つのホストグループで設定する必要があります。<br><br>このパラメーターは、[テンプレートダッシュボード](/manual/api/reference/templatedashboard/object)でウィジェットを設定する場合はサポートされません。|
|*障害*|<|1|problem|障害[イベント名](/manual/config/triggers/trigger#configuration)（大文字小文字を区別しない、完全一致または部分一致）。|
|*深刻度*|<|0|severities.0|トリガーの深刻度。<br><br>0 - 未分類;<br>1 - 情報;<br>2 - 警告;<br>3 - 軽度障害;<br>4 - 障害;<br>5 - 重度障害。<br><br>デフォルト: 空（すべて有効）。<br><br>注: 複数の値を設定するには、プロパティ名の番号を増やして各値ごとにダッシュボードウィジェットフィールドオブジェクトを作成します。|
|*障害タグ*|<|<|<|<|
|<|*評価タイプ*|0|evaltype|0 - *(デフォルト)* And/Or;<br>2 - Or。|
|^|*タグ名*|1|tags.0.tag|任意の文字列値。<br><br>注: プロパティ名の番号は、タグ評価リスト内のタグの順序を参照します。<br><br>[パラメーターの動作](/manual/api/reference_commentary#parameter-behavior):<br>- *障害タグ*を設定する場合は*必須*|
|^|*演算子*|0|tags.0.operator|0 - 含む;<br>1 - 等しい;<br>2 - 含まない;<br>3 - 等しくない;<br>4 - 存在する;<br>5 - 存在しない。<br><br>注: プロパティ名の番号は、タグ評価リスト内のタグの順序を参照します。<br><br>[パラメーターの動作](/manual/api/reference_commentary#parameter-behavior):<br>- *障害タグ*を設定する場合は*必須*|
|^|*タグ値*|1|tags.0.value|任意の文字列値。<br><br>注: プロパティ名の番号は、タグ評価リスト内のタグの順序を参照します。<br><br>[パラメーターの動作](/manual/api/reference_commentary#parameter-behavior):<br>- *障害タグ*を設定する場合は*必須*|
|*期間*|<|1|time_period.\_reference|`DASHBOARD._timeperiod` - ダッシュボードの[期間セレクター](/manual/web_interface/time_period_selector)をデータソースとして設定;<br>`ABCDE._timeperiod` - [互換性のあるウィジェット](/manual/web_interface/frontend_sections/dashboards/widgets#widget-compatibility)（*参照*パラメーターを"`ABCDE`"に設定）をデータソースとして設定。<br><br>デフォルト: `DASHBOARD._timeperiod`<br><br>または、*From*および*To*パラメーターで期間のみを設定することもできます。|
|<|*From*|1|time_period.from|絶対（`YYYY-MM-DD hh:mm:ss`）または[相対](/manual/web_interface/time_period_selector)時間構文（`now`、`now/d`、`now/w-1w`など）での有効な時間文字列。<br><br>[パラメーターの動作](/manual/api/reference_commentary#parameter-behavior):<br>- *期間*が設定されていない場合に*サポート*<br>- `time_period.to`が設定されている場合は*必須*|
|^|*To*|1|time_period.to|絶対（`YYYY-MM-DD hh:mm:ss`）または[相対](/manual/web_interface/time_period_selector)時間構文（`now`、`now/d`、`now/w-1w`など）での有効な時間文字列。<br><br>[パラメーターの動作](/manual/api/reference_commentary#parameter-behavior):<br>- *期間*が設定されていない場合に*サポート*<br>- `time_period.from`が設定されている場合は*必須*|
|*トリガーの表示数*|<|0|show_lines|1-100の範囲で指定可能。<br><br>デフォルト: 10。|

[comment]: # ({/27da08e4-b5e67e19})

[comment]: # ({599fd163-441500f2})
### 例

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

[comment]: # ({/599fd163-441500f2})

[comment]: # ({379c5c86-681121e2})
#### *Top triggers*ウィジェットの設定

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

[リクエスト](/manual/api#performing-requests):

```json
{
    "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
}
```

レスポンス:

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

[comment]: # ({/379c5c86-681121e2})

[comment]: # ({e9d30322-d81fc119})
### 参照

-   [Dashboard widget field](/manual/api/reference/dashboard/object#dashboard-widget-field)
-   [`dashboard.create`](/manual/api/reference/dashboard/create)
-   [`dashboard.update`](/manual/api/reference/dashboard/update)

[comment]: # ({/e9d30322-d81fc119})
