15 アイテムカード

説明

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

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

パラメータ

Item card ウィジェットでサポートされるパラメータは以下のとおりです。

Parameter type name value
Refresh interval 0 rf_rate 0 - 更新しない;
10 - 10秒;
30 - 30秒;
60 - (default) 1分;
120 - 2分;
600 - 10分;
900 - 15分.
Item 4 itemid.0 アイテム ID.

Parameter behavior:
- required if Item (Widget) is not set
Item (Widget) 1 itemid._reference アイテム ID の代わりに:
ABCDE._itemid - Reference パラメータが "ABCDE" に設定された 互換ウィジェット を、アイテムのデータソースとして設定します。

Parameter behavior:
- required if Item is not set
Show 0 sections.0 0 - 説明;
1 - エラーテキスト;
2 - メトリクス;
3 - 最新データ;
4 - 情報の種類;
5 - トリガー;
6 - ホストインターフェース;
7 - 種類;
8 - ホストインベントリ;
9 - タグ.

Note: プロパティ名の数値は、セクション一覧内のセクション順序を参照します。複数のセクションを設定するには、各セクションごとにプロパティ名の数値を増やした Webインターフェース ウィジェットフィールドオブジェクトを作成してください。
Override host 1 override_hostid._reference ABCDE._hostid - Reference パラメータが "ABCDE" に設定された 互換ウィジェット を、ホストのデータソースとして設定します;
DASHBOARD._hostid - ダッシュボードの Host セレクター をホストのデータソースとして設定します。

Default: "" (空)

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

スパークライン

Show が "Latest data" に設定されている場合、以下のパラメータがサポートされます。

Parameter type name value
Width 0 sparkline.width 0-10 の範囲の値を指定できます。

デフォルト: 1。
Fill 0 sparkline.fill 0-10 の範囲の値を指定できます。

デフォルト: 3。
Color 1 sparkline.color 16進数のカラーコード(例: FF0000)。

デフォルト: 42A5F5
Time period 1 sparkline.time_period._reference DASHBOARD._timeperiod - Time period セレクター をデータソースとして設定します。
ABCDE._timeperiod - reference パラメータが ABCDE に等しい 互換ウィジェット をデータソースとして設定します。

デフォルト: ""(空)

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

デフォルト: now-1h。

パラメータの動作:
- Time period が設定されていない場合は supported
- sparkline.time_period.to が設定されている場合は required
To 1 sparkline.time_period.to 絶対時間形式(YYYY-MM-DD hh:mm:ss)または 相対 時間構文(nownow/dnow/w-1w など)で指定する有効な時刻文字列。

デフォルト: now。

パラメータの動作:
- Time period が設定されていない場合は supported
- time_period.from が設定されている場合は required
History data 0 sparkline.history 0 - (default) 自動;
1 - 履歴;
2 - トレンド。

以下の例は、アイテムカードウィジェットのダッシュボードウィジェットフィールドオブジェクトの設定のみを説明することを目的としています。 ダッシュボードの設定の詳細については、dashboard.createを参照してください。

アイテムカードウィジェットの設定

これらのセクションを表示するアイテムカードウィジェットを設定します: "説明"、"最新データ"、"トリガー"、"タグ"。

リクエスト:

{
    "jsonrpc": "2.0",
    "method": "dashboard.create",
    "params": {
        "name": "My dashboard",
        "display_period": 30,
        "auto_start": 1,
        "pages": [
            {
                "widgets": [
                    {
                        "type": "itemcard",
                        "name": "Item card",
                        "x": 0,
                        "y": 0,
                        "width": 14,
                        "height": 7,
                        "view_mode": 0,
                        "fields": [
                            {
                                "type": 4,
                                "name": "itemid.0",
                                "value": 42257
                            },
                            {
                                "type": 0,
                                "name": "sections.0",
                                "value": 0
                            },
                            {
                                "type": 0,
                                "name": "sections.1",
                                "value": 3
                            },
                            {
                                "type": 0,
                                "name": "sections.2",
                                "value": 5
                            },
                            {
                                "type": 0,
                                "name": "sections.3",
                                "value": 9
                            }
                        ]
                    }
                ]
            }
        ],
        "userGroups": [
            {
                "usrgrpid": 7,
                "permission": 2
            }
        ],
        "users": [
            {
                "userid": 1,
                "permission": 3
            }
        ]
    },
    "id": 1
}

レスポンス:

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

こちらもご参照ください