[comment]: # ({093ad1f3-522e6f46})
# 3 Data overview

[comment]: # ({/093ad1f3-522e6f46})

[comment]: # ({77f1ca42-ae03fe60})
::: noteimportant
このウィジェットは非推奨であり、今後のメジャーリリースで削除される予定です。代わりに[*上位ホスト*](/manual/api/reference/dashboard/widget_fields/top_hosts)ウィジェットの使用を検討してください。
:::

[comment]: # ({/77f1ca42-ae03fe60})

[comment]: # ({4d8585e6-10fd6f8e})
### 説明

これらのパラメーターと、各ダッシュボードウィジェットフィールドオブジェクトの有効なプロパティ値を使用することで、`dashboard.create`メソッドおよび`dashboard.update`メソッドで[*データの概要*](/manual/web_interface/frontend_sections/dashboards/widgets/data_overview)ウィジェットを設定できます。

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

[comment]: # ({/4d8585e6-10fd6f8e})

[comment]: # ({e34a2a70-d1871136})
### パラメーター

*データの概要*ウィジェットでは、以下のパラメーターがサポートされています。

|パラメーター|<|[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)にウィジェットを構成する場合、このパラメーターはサポートされていません。|
|<|*ホストグループ (ウィジェット)*|1|groupids.\_reference|[ホストグループ](/manual/api/reference/hostgroup/get)IDの代わり:<br>`ABCDE._hostgroupids` - ホストグループのデータソースとして、[互換性をあるウィジェット](/manual/web_interface/frontend_sections/dashboards/widgets#widget-compatibility) (その*参照*パラメーターが"`ABCDE`"に設定されている)を設定します。<br><br>[テンプレートダッシュボード](/manual/api/reference/templatedashboard/object)にウィジェットを構成する場合、このパラメーターはサポートされていません。|
|*Hosts*|<|3|hostids.0|[ホスト](/manual/api/reference/host/get)ID。<br><br>注: 複数のホストを設定するには、プロパティ名に増分番号を付けたホストごとにダッシュボードウィジェットフィールドオブジェクトを作成してください。複数のホストの場合、パラメーター*ホストグループ*はまったく設定しないか、設定されたホストが属するホストグループを少なくとも1つ設定する必要があります。<br><br>[テンプレートダッシュボード](/manual/api/reference/templatedashboard/object)にウィジェットを構成する場合、このパラメーターはサポートされていません。|
|<|*ホスト (ウィジェット/ダッシュボード)*|1|hostids.\_reference|[ホスト](/manual/api/reference/host/get)IDの代わり:<br>`DASHBOARD.hostids` - ホストのデータソースとして、[*ホスト*セレクター](/manual/web_interface/frontend_sections/dashboards/widgets#override-host)を設定します。<br>`ABCDE._hostids` - ホストのデータソースとして、[互換性をあるウィジェット](/manual/web_interface/frontend_sections/dashboards/widgets#widget-compatibility) (その*参照*パラメーターが"`ABCDE`"に設定されている)を設定します。<br><br>[テンプレートダッシュボード](/manual/api/reference/templatedashboard/object)にウィジェットを構成する場合、このパラメーターはサポートされていません。|
|*アイテムタグ*|<|<|<|<|
|<|*評価タイプ*|0|evaltype|0 - *(デフォルト)* And/Or<br>2 - Or|
|^|*タグ名*|1|tags.tag.0|任意の文字列値。<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>- *アイテムタグ*を設定する場合、*必須*|
|*メンテナンス中の障害を表示*|<|0|show_suppressed|0 - *(デフォルト)* 無効<br>1 - 有効|
|*ホストの位置*|<|0|style|0 - *(デフォルト)* 左<br>1 - 上|

[comment]: # ({/e34a2a70-d1871136})

[comment]: # ({7663ef93-9f13be38})
### 例

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

[comment]: # ({/7663ef93-9f13be38})

[comment]: # ({01f5fe22-afab3ffb})
#### *データの概要*ウィジェットの設定

ホスト"10084"のデータと、名前が"component"のタグに値として"cpu"が含まれるアイテムのみを表示する*データの概要*ウィジェットを設定します。
さらに、ホストを最上位に表示します。

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

```json
{
    "jsonrpc": "2.0",
    "method": "dashboard.create",
    "params": {
        "name": "My dashboard",
        "display_period": 30,
        "auto_start": 1,
        "pages": [
            {
                "widgets": [
                    {
                        "type": "dataover",
                        "name": "Data overview",
                        "x": 0,
                        "y": 0,
                        "width": 36,
                        "height": 5,
                        "view_mode": 0,
                        "fields": [
                            {
                                "type": 3,
                                "name": "hostids.0",
                                "value": 10084
                            },
                            {
                                "type": 1,
                                "name": "tags.0.tag",
                                "value": "component"
                            },
                            {
                                "type": 0,
                                "name": "tags.0.operator",
                                "value": 0
                            },
                            {
                                "type": 1,
                                "name": "tags.0.value",
                                "value": "cpu"
                            },
                            {
                                "type": 0,
                                "name": "style",
                                "value": 1
                            }
                        ]
                    }
                ]
            }
        ],
        "userGroups": [
            {
                "usrgrpid": 7,
                "permission": 2
            }
        ],
        "users": [
            {
                "userid": 1,
                "permission": 3
            }
        ]
    },
    "id": 1
}
```

レスポンス:

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

[comment]: # ({/01f5fe22-afab3ffb})

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

-   [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-a871b266})