これらのパラメーターと、各ダッシュボードウィジェットフィールドオブジェクトの有効なプロパティ値を使用することで、dashboard.createメソッドおよびdashboard.updateメソッドでURLウィジェットを設定できます。
ウィジェットのfieldsプロパティは、ダッシュボードの作成または更新時に検証されません。 これにより、ユーザーは組み込みウィジェットを変更したり、カスタムウィジェットを作成したりできますが、ウィジェットを誤って作成または更新してしまうリスクも生じます。 URLウィジェットを正常に作成または更新するには、以下の表に記載されているパラメーターの動作を参照してください。
URLウィジェットでサポートされているパラメータは以下の通りです。
| パラメータ | タイプ | 名前 | 値 |
|---|---|---|---|
| リフレッシュ間隔 | 0 | rf_rate | 0 - (デフォルト) リフレッシュなし; 10 - 10秒; 30 - 30秒; 60 - 1分; 120 - 2分; 600 - 10分; 900 - 15分。 |
| URL | 1 | url | 有効なURL文字列。 パラメータの動作: - 必須 |
| ホストの上書き | 1 | override_hostid._reference | ABCDE._hostid - 互換性のあるウィジェット(参照パラメータを"ABCDE"に設定)をホストのデータソースとして設定;DASHBOARD._hostid - ダッシュボードのホストセレクタをホストのデータソースとして設定。このパラメータはテンプレートダッシュボードでウィジェットを設定する場合はサポートされません。 |
次の例は、URLウィジェットのダッシュボードウィジェットフィールドオブジェクトの設定を説明することだけを目的としています。 ダッシュボードの設定の詳細については、dashboard.createを参照してください。
Zabbixマニュアルのホームページを表示するURLウィジェットを設定します。
{
"jsonrpc": "2.0",
"method": "dashboard.create",
"params": {
"name": "My dashboard",
"display_period": 30,
"auto_start": 1,
"pages": [
{
"widgets": [
{
"type": "url",
"name": "URL",
"x": 0,
"y": 0,
"width": 36,
"height": 5,
"view_mode": 0,
"fields": [
{
"type": 1,
"name": "url",
"value": "https://www.zabbix.com/documentation/8.0/en"
}
]
}
]
}
],
"userGroups": [
{
"usrgrpid": 7,
"permission": 2
}
],
"users": [
{
"userid": 1,
"permission": 3
}
]
},
"id": 1
}レスポンス: