8 地图

描述

这些参数以及相应仪表板 widget 字段的可能属性值 objects 允许在 dashboard.createdashboard.update 方法中配置 Geomap widget。

widget fields 属性在创建或 update 仪表板时不会被验证。 这允许用户修改 built-in widgets 和 create custom widgets,但也带来了创建或更新部件时出错的风险。 为确保成功创建或 update Geomap 部件,请参考下表中列出的参数行为。

参数

Geomap 小部件支持以下参数。

参数 仪表板小部件字段 名称
Refresh interval 0 rf_rate 0 - 无刷新;
10 - 10 秒;
30 - 30 秒;
60 - (默认) 1 分钟;
120 - 2 分钟;
600 - 10 分钟;
900 - 15 分钟。
Host groups 2 groupids.0 Host group ID。

注意:要配置多个 主机 组,需为每个 主机组 使用递增的属性名称 create 仪表板 widget 字段 object。

如果在 template dashboard 上配置 widget,则不支持此参数。
主机 组(小部件) 1 groupids._reference 请勿使用 Host group ID:
ABCDE._hostgroupids - 应将一个 部件兼容性(将其 Reference 参数设为 "ABCDE")设置为 主机 组的数据源。

如果在 template dashboard 上配置小get,则不支持此参数。
Hosts 3 hostids.0 Host ID。

注意:要配置多个 主机,请create一个仪表板 widget 字段 object,并为每个 主机 在属性名称中使用递增的编号。对于多个 主机,参数 主机 组 必须要么完全不配置,要么至少配置一个 主机组,且已配置的 主机 必须属于该组。

如果在 template dashboard 上配置 widget,则不支持此参数。
主机(Widget/Dashboard) 1 hostids._reference 无需使用 Host ID:
DASHBOARD.hostids - 将 覆盖主机 设置为 主机 的数据源;
ABCDE._hostids - 将一个 部件兼容性(将其 Reference 参数设置为 "ABCDE")设置为 主机 的数据源。

如果在 template dashboard 上配置 widget,则不支持此参数。
Tags
评估类型 0 evaltype 0 - (默认) And/Or;
2 - Or。

如果在template dashboard上配置widget,则不支持此参数。
标签名称 1 tags.0.tag 任意 string 值。

注意:属性名称中的数字表示标签评估列表中的标签顺序。

参数行为:
- 配置 标签 时为 必填

template dashboard 上配置 widget 时不支持此参数。
操作符 0 tags.0.operator 0 - 包含;
1 - 等于;
2 - 不包含;
3 - 不等于;
4 - 存在;
5 - 不存在。

注意:属性名称中的数字引用标签评估列表中的标签顺序。

参数行为:
- 配置 标签必填

在配置 template dashboard 上的 widget 时,不支持此参数。
标签值 1 tags.0.value 任意 string 值。

注意:属性名称中的数字引用标签评估列表中的标签顺序。

参数行为:
- 配置 标签 时为必填项

template dashboard 上配置 widget 时不支持此参数。
Initial view 1 default_view 逗号分隔的 纬度经度缩放级别可选,取值范围为 0-30)。
示例: 40.6892494,-74.0466891,10
Reference 1 reference 任何由 5 个字符组成的 string 值(例如 ABCDEJBPNL)。此值在该 widget 所属的仪表板内必须唯一。

参数行为:
- 必填

示例

以下示例仅用于描述如何为Geomap小部件配置仪表板的 widget 字段 objects。 有关配置仪表板的更多信息,请参阅 dashboard.create

配置 Geomap 部件

配置一个Geomap小部件get,根据以下标签配置显示来自主机组"2"和"22"的主机: 名称为"component"的标签包含值"node",名称为"location"的标签等于值"New York"。 另外,将地图的初始视图设置为坐标"40.6892494"(纬度),"-74.0466891"(经度),缩放级别为"10"。

执行请求:

{
           "jsonrpc": "2.0",
           "method": "dashboard.create",
           "params": {
               "name": "My dashboard",
               "display_period": 30,
               "auto_start": 1,
               "pages": [
                   {
                       "widgets": [
                           {
                               "type": "geomap",
                               "name": "Geomap",
                               "x": 0,
                               "y": 0,
                               "width": 36,
                               "height": 5,
                               "view_mode": 0,
                               "fields": [
                                   {
                                       "type": 2,
                                       "name": "groupids.0",
                                       "value": 22
                                   },
                                   {
                                       "type": 2,
                                       "name": "groupids.1",
                                       "value": 2
                                   },
                                   {
                                       "type": 1,
                                       "name": "default_view",
                                       "value": "40.6892494,-74.0466891,10"
                                   },
                                   {
                                       "type": 0,
                                       "name": "evaltype",
                                       "value": 2
                                   },
                                   {
                                       "type": 1,
                                       "name": "tags.0.tag",
                                       "value": "component"
                                   },
                                   {
                                       "type": 0,
                                       "name": "tags.0.operator",
                                       "value": 0
                                   },
                                   {
                                       "type": 1,
                                       "name": "tags.0.value",
                                       "value": "node"
                                   },
                                   {
                                       "type": 1,
                                       "name": "tags.1.tag",
                                       "value": "location"
                                   },
                                   {
                                       "type": 0,
                                       "name": "tags.1.operator",
                                       "value": 1
                                   },
                                   {
                                       "type": 1,
                                       "name": "tags.1.value",
                                       "value": "New York"
                                   }
                               ]
                           }
                       ]
                   }
               ],
               "userGroups": [
                   {
                       "usrgrpid": 7,
                       "permission": 2
                   }
               ],
               "users": [
                   {
                       "userid": 1,
                       "permission": 3
                   }
               ]
           },
           "id": 1
       }

响应:

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

另请参阅