12 Item value

説明

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

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

パラメータ

アイテム値ウィジェットでは、以下のパラメータがサポートされています。

パラメータ type name value
更新間隔 0 rf_rate 0 - 更新なし;
10 - 10秒;
30 - 30秒;
60 - (デフォルト) 1分;
120 - 2分;
600 - 10分;
900 - 15分
アイテム
(必須)
4 itemid アイテム ID
表示 0 表示 1 - 説明;
2 - 値;
3 - 時間;
4 - 変更インジケーター

デフォルト: 1、2、3、4 (すべて有効)。

注: 複数の値を設定するには、値ごとにダッシュボードウィジェットフィールドオブジェクトを作成してください。
動的項目 0 dynamic 0 - (デフォルト) 無効;
1 - 有効
詳細設定 0 adv_conf 0 - (デフォルト) 無効;
1 - 有効

詳細設定

詳細設定が"有効"に設定されている場合、以下のパラメータがサポートされます。

パラメータ type name value
背景色 1 bg_color 16進数の色コード(例:FF0000

デフォルト:""(空)
説明

詳細設定が"有効"に設定され、表示が"説明"に設定されている場合は、以下のパラメータがサポートされます。

パラメータ type 名前
説明 1 説明 マクロを含む任意の文字列値
サポートされているマクロ: {HOST.*}、{ITEM.*}、{INVENTORY.*}、ユーザーマクロ

デフォルト: {ITEM.NAME}
水平位置 0 desc_h_pos 0 - 左;
1 - (デフォルト) 中央;
2 - 右

2 つ以上の要素 (説明、値、時間) が同じ 水平位置垂直位置 を共有することはできません。
垂直位置 0 desc_v_pos 0 - 上;
1 - 中央;
2 - (デフォルト)

2 つ以上の要素 (説明、値、時間) が同じ 水平位置垂直位置 を共有することはできません。
サイズ 0 desc_size 有効な値の範囲は 1~100 です。

デフォルト: 15
太字 0 desc_bold 0 - (デフォルト) 無効;
1 - 有効
Color 1 desc_color 16進数カラーコード(例:FF0000

デフォルト:""(空)

詳細設定が"有効"に設定され、表示が"値"に設定されている場合は、以下のパラメータがサポートされます。

パラメータ type name value
小数点以下の桁数
小数点以下の桁数 0 decimal_places 有効な値の範囲は1~10です。

デフォルト: 2
サイズ 0 decimal_size 有効な値の範囲は1~100です。

デフォルト: 35
位置
水平位置 0 value_h_pos 0 - 左;
1 - (デフォルト) 中央;
2 - 右

2 つ以上の要素 (説明、値、時間) が同じ 水平位置垂直位置 を共有することはできません。
垂直位置 0 value_v_pos 0 - 上;
1 - (デフォルト) 中央;
2 - 下

2 つ以上の要素 (説明、値、時間) が同じ 水平位置垂直位置 を共有することはできません。
サイズ 0 value_size 有効な値の範囲は 1~100 です。

デフォルト: 45
太字 0 value_bold 0 - 無効;
1 - (デフォルト) 有効
1 value_color 16進数の色コード(例:FF0000

デフォルト:""(空)
単位
単位(チェックボックス) 0 units_show 0 - 無効
1 - (デフォルト) 有効
単位(値) 1 units 任意の文字列値
位置 0 units_pos 0 - 前の値
1 - 上の値
2 - (デフォルト) 後の値
3 - 下の値
サイズ 0 units_size 有効な値の範囲は1~100です。

デフォルト:35
太字 0 units_bold 0 - 無効;
1 - (デフォルト) 有効
1 units_color 16進数の色コード (例: FF0000)

デフォルト: "" (空)
時間

詳細設定が"有効"に設定され、表示が"時間"に設定されている場合に、以下のパラメータがサポートされます。

パラメータ type 名前
水平位置 0 time_h_pos 0 - 左;
1 - (デフォルト) 中央;
2 - 右

2つ以上の要素(説明、値、時間)で同じ水平位置垂直位置を共有することはできません。
垂直位置 0 time_v_pos 0 - (デフォルト) 上;
1 - 中央;
2 - 下

2 つ以上の要素 (説明、値、時間) が同じ 水平位置垂直位置 を共有することはできません。
サイズ 0 time_size 有効な値の範囲は 1~100 です。

デフォルト: 15
太字 0 time_bold 0 - (デフォルト) 無効;
1 - 有効
1 time_color 16 進数のカラーコード (例: FF0000)

デフォルト: "" (空)
Change indicator

詳細設定が"有効"に設定され、表示が"変更インジケーター"に設定されている場合に、以下のパラメーターがサポートされます。

パラメーター type name value
変更インジケーター↑の色 1 up_color 16進数カラーコード(例:FF0000

デフォルト:""(空)
変更インジケーター↓の色 1 down_color 16進数カラーコード(例:FF0000

デフォルト:""(空)
インジケーターの色変更 1 updown_color 16進数カラーコード(例:FF0000

デフォルト:""(空)

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

アイテムの値ウィジェットの設定

アイテム"42266"(Zabbixエージェントの可用性)のアイテム値を表示するアイテムの値ウィジェットを設定します。さらに、複数の詳細オプションを使用してウィジェットを視覚的に微調整します。

リクエスト:

{
           "jsonrpc": "2.0",
           "method": "dashboard.create",
           "params": {
               "name": "My dashboard",
               "display_period": 30,
               "auto_start": 1,
               "pages": [
                   {
                       "widgets": [
                           {
                               "type": "item",
                               "name": "Item value",
                               "x": 0,
                               "y": 0,
                               "width": 4,
                               "height": 3,
                               "view_mode": 0,
                               "fields": [
                                   {
                                       "type": 4,
                                       "name": "itemid",
                                       "value": 42266
                                   },
                                   {
                                       "type": 0,
                                       "name": "show",
                                       "value": 1
                                   },
                                   {
                                       "type": 0,
                                       "name": "show",
                                       "value": 2
                                   },
                                   {
                                       "type": 0,
                                       "name": "show",
                                       "value": 3
                                   },
                                   {
                                       "type": 0,
                                       "name": "adv_conf",
                                       "value": 1
                                   },
                                   {
                                       "type": 1,
                                       "name": "bg_color",
                                       "value": "D1C4E9"
                                   },
                                   {
                                       "type": 1,
                                       "name": "description",
                                       "value": "Agent status"
                                   },
                                   {
                                       "type": 0,
                                       "name": "desc_h_pos",
                                       "value": 0
                                   },
                                   {
                                       "type": 0,
                                       "name": "desc_v_pos",
                                       "value": 0
                                   },
                                   {
                                       "type": 0,
                                       "name": "desc_bold",
                                       "value": 1
                                   },
                                   {
                                       "type": 1,
                                       "name": "desc_color",
                                       "value": "F06291"
                                   },
                                   {
                                       "type": 0,
                                       "name": "value_h_pos",
                                       "value": 0
                                   },
                                   {
                                       "type": 0,
                                       "name": "value_size",
                                       "value": 25
                                   },
                                   {
                                       "type": 1,
                                       "name": "value_color",
                                       "value": "FFFF00"
                                   },
                                   {
                                       "type": 0,
                                       "name": "units_show",
                                       "value": 0
                                   },
                                   {
                                       "type": 0,
                                       "name": "time_h_pos",
                                       "value": 2
                                   },
                                   {
                                       "type": 0,
                                       "name": "time_v_pos",
                                       "value": 2
                                   },
                                   {
                                       "type": 0,
                                       "name": "time_size",
                                       "value": 10
                                   },
                                   {
                                       "type": 0,
                                       "name": "time_bold",
                                       "value": 1
                                   },
                                   {
                                       "type": 1,
                                       "name": "time_color",
                                       "value": "9FA8DA"
                                   }
                               ]
                           }
                       ]
                   }
               ],
               "userGroups": [
                   {
                       "usrgrpid": 7,
                       "permission": 2
                   }
               ],
               "users": [
                   {
                       "userid": 1,
                       "permission": 3
                   }
               ]
           },
           "auth": "038e1d7b1735c6a5436ee9eae095879e",
           "id": 1
       }

レスポンス:

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

参照