映射 object

以下objects与mapAPI直接相关。

地图

地图对象具有以下属性。

Property Type Description
sysmapid ID 地图的 ID。

Property behavior:
- read-only
- 更新操作时为 required
height integer 地图的高度,单位为像素。

Property behavior:
- 创建操作时为 required
name string 地图名称。

Property behavior:
- 创建操作时为 required
width integer 地图的宽度,单位为像素。

Property behavior:
- 创建操作时为 required
backgroundid ID 用作地图背景的图像 ID。
expand_macros integer 配置地图时,是否在标签中展开宏。

Possible values:
0 - (default) 不展开宏;
1 - 展开宏。
expandproblem integer 当某个元素只有一个问题时,是否显示问题触发器。

Possible values:
0 - 始终显示问题数量;
1 - (default) 如果只有一个问题,则显示问题触发器。
grid_align integer 是否启用网格对齐。

Possible values:
0 - 禁用网格对齐;
1 - (default) 启用网格对齐。
grid_show integer 是否在地图上显示网格。

Possible values:
0 - 不显示网格;
1 - (default) 显示网格。
grid_size integer 地图网格的大小,单位为像素。

Supported values: 20, 40, 50, 75 and 100.

Default: 50.
highlight integer 是否启用图标高亮显示。

Possible values:
0 - 禁用高亮显示;
1 - (default) 启用高亮显示。
iconmapid ID 地图上使用的图标映射 ID。
label_format integer 是否启用高级标签。

Possible values:
0 - (default) 禁用高级标签;
1 - 启用高级标签。
label_location integer 地图元素标签的位置。

Possible values:
0 - (default) 底部;
1 - 左侧;
2 - 右侧;
3 - 顶部。
label_string_host string 主机元素的自定义标签。

Property behavior:
- 如果 label_type_host 设置为 "custom",则为 required
label_string_hostgroup string 主机组元素的自定义标签。

Property behavior:
- 如果 label_type_hostgroup 设置为 "custom",则为 required
label_string_image string 图像元素的自定义标签。

Property behavior:
- 如果 label_type_image 设置为 "custom",则为 required
label_string_map string 地图元素的自定义标签。

Property behavior:
- 如果 label_type_map 设置为 "custom",则为 required
label_string_trigger string 触发器元素的自定义标签。

Property behavior:
- 如果 label_type_trigger 设置为 "custom",则为 required
label_type integer 地图元素的标签类型。

Possible values:
0 - 标签;
1 - IP 地址;
2 - (default) 元素名称;
3 - 仅状态;
4 - 无。
label_type_host integer 主机元素的标签类型。

Possible values:
0 - 标签;
1 - IP 地址;
2 - (default) 元素名称;
3 - 仅状态;
4 - 无;
5 - 自定义。
label_type_hostgroup integer 主机组元素的标签类型。

Possible values:
0 - 标签;
2 - (default) 元素名称;
3 - 仅状态;
4 - 无;
5 - 自定义。
label_type_image integer 主机组元素的标签类型。

Possible values:
0 - 标签;
2 - (default) 元素名称;
4 - 无;
5 - 自定义。
label_type_map integer 地图元素的标签类型。

Possible values:
0 - 标签;
2 - (default) 元素名称;
3 - 仅状态;
4 - 无;
5 - 自定义。
label_type_trigger integer 触发器元素的标签类型。

Possible values:
0 - 标签;
2 - (default) 元素名称;
3 - 仅状态;
4 - 无;
5 - 自定义。
markelements integer 是否高亮显示最近更改过状态的地图元素。

Possible values:
0 - (default) 不高亮显示元素;
1 - 高亮显示元素。
severity_min integer 将在地图上显示的触发器的最低严重性。

有关支持的触发器严重性列表,请参阅 trigger severity property
show_unack integer 问题的显示方式。

Possible values:
0 - (default) 显示所有问题的数量;
1 - 仅显示未确认问题的数量;
2 - 分别显示已确认和未确认问题的数量。
userid ID 地图所有者的用户 ID。
private integer 地图共享类型。

Possible values:
0 - 公开地图;
1 - (default) 私有地图。
show_suppressed integer 是否显示被抑制的问题。

Possible values:
0 - (default) 隐藏被抑制的问题;
1 - 显示被抑制的问题。

地图元素

地图元素对象定义了在地图上显示的对象。它具有以下属性。

Property Type Description
selementid ID 地图元素的 ID。

Property behavior:
- 只读
elements array 元素数据对象。

Property behavior:
- 当 elementtype 设置为 "host"、"map"、"trigger" 或 "host group" 时为 必需
elementtype integer 地图元素类型。

可能的值:
0 - host;
1 - map;
2 - trigger;
3 - host group;
4 - image.

Property behavior:
- 必需
iconid_off ID 用于在默认状态下显示该元素的图像 ID。

Property behavior:
- 必需
areatype integer 应如何显示单独的主机组中的主机。

可能的值:
0 - (默认) 主机组元素将占据整个地图;
1 - 主机组元素将具有固定大小。
elementsubtype integer 应如何在地图上显示主机组元素。

可能的值:
0 - (默认) 将主机组显示为单个元素;
1 - 分别显示组中的每个主机。
evaltype integer 地图元素标签筛选条件的评估方法

可能的值:
0 - (默认) 与/或;
2 - 或。
height integer 固定大小主机组元素的高度,单位为像素。

默认值:200。
iconid_disabled ID 用于显示已禁用地图元素的图像 ID。

Property behavior:
- 当 elementtype 设置为 "host"、"map"、"trigger" 或 "host group" 时 支持
iconid_maintenance ID 用于显示处于维护中的地图元素的图像 ID。

Property behavior:
- 当 elementtype 设置为 "host"、"map"、"trigger" 或 "host group" 时 支持
iconid_on ID 用于显示存在问题的地图元素的图像 ID。

Property behavior:
- 当 elementtype 设置为 "host"、"map"、"trigger" 或 "host group" 时 支持
label string 元素标签。
label_location integer 地图元素标签的位置。

可能的值:
-1 - (默认) 默认位置;
0 - 底部;
1 - 左侧;
2 - 右侧;
3 - 顶部。
permission integer 权限级别类型。

可能的值:
-1 - 无;
2 - 只读;
3 - 读写。
sysmapid ID 该元素所属地图的 ID。

Property behavior:
- 只读
urls array 地图元素 URL。

地图元素 URL 对象在下文详细说明
use_iconmap integer 主机元素是否必须使用图标映射。

可能的值:
0 - 不使用图标映射;
1 - (默认) 使用图标映射。
viewtype integer 主机组元素放置算法。

可能的值:
0 - (默认) 网格。
width integer 固定大小主机组元素的宽度,单位为像素。

默认值:200。
x integer 元素的 X 坐标,单位为像素。

默认值:0。
y integer 元素的 Y 坐标,单位为像素。

默认值:0。

地图元素主机

地图元素 Host 对象定义一个主机元素。

Property Type Description
hostid ID 主机的 ID。

地图元素 主机组

地图元素 Host group 对象定义一个主机组元素。

Property Type Description
groupid ID 主机组的 ID。

地图元素 Map

地图元素 Map 对象定义一个地图元素。

Property Type Description
sysmapid ID 地图的 ID。

地图元素触发器

地图元素 Trigger 对象定义一个或多个触发器元素。

Property Type Description
triggerid ID 触发器的 ID。

地图元素 Tag

Map element Tag 对象具有以下属性。

Property Type Description
tag string 地图元素标签名称。

Property behavior:
- required
operator integer 地图元素标签条件 operator

Possible values:
0 - (default) 包含;
1 - 等于;
2 - 不包含;
3 - 不等于;
4 - 存在;
5 - 不存在。
value string 地图元素标签值。

地图元素 URL

地图元素 URL 对象定义了一个可点击链接,该链接将可用于特定的地图元素。它具有以下属性:

Property Type Description
sysmapelementurlid ID 地图元素 URL 的 ID。

Property behavior:
- 只读
name string 链接标题。

Property behavior:
- 必填
url string 链接 URL。

Property behavior:
- 必填
selementid ID 该 URL 所属的地图元素 ID。

地图链接

地图链接对象定义了两个地图元素之间的链接。它具有以下属性。

Property Type Description
linkid ID 地图链接的 ID。

属性行为:
- 只读
selementid1 ID 一端所链接的第一个地图元素的 ID。

属性行为:
- 必填
selementid2 ID 另一端所链接的第一个地图元素的 ID。

属性行为:
- 必填
color string 线条颜色,使用十六进制颜色代码表示。

默认值:000000
drawtype integer 链接线条的绘制样式。

可选值:
0 - (默认) 线条;
2 - 粗线;
3 - 点线;
4 - 虚线。
label string 链接标签。
linktriggers array 用作链接状态指示器的地图链接触发器。

地图链接触发器对象的详细说明如下
permission integer 权限级别类型。

可选值:
-1 - 无;
2 - 只读;
3 - 读写。
sysmapid ID 该链接所属地图的 ID。

地图链接触发器

地图链接触发器对象根据触发器的状态定义地图链接状态指示器。它具有以下属性:

Property Type Description
linktriggerid ID 地图链接触发器的 ID。

Property behavior:
- 只读
triggerid ID 用作链接指示器的触发器 ID。

Property behavior:
- 必填
color string 指示器颜色,采用十六进制颜色代码。

默认值:DD0000
drawtype integer 指示器绘制样式。

可能的值:
0 - (默认) 线;
2 - 粗线;
3 - 点线;
4 - 虚线。
linkid ID 该 link trigger 所属的地图链接 ID。

地图 URL

地图 URL 对象定义了一个可点击链接,该链接将对地图上特定类型的所有元素可用。它具有以下属性:

Property Type Description
sysmapurlid ID 地图 URL 的 ID。

Property behavior:
- read-only
name string 链接标题。

Property behavior:
- required
url string 链接 URL。

Property behavior:
- required
elementtype integer 该 URL 可用的地图元素类型。

有关支持类型的列表,请参见 map element type property

默认值:0。
sysmapid ID 该 URL 所属地图的 ID。

地图用户

基于用户的地图权限列表。它具有以下属性:

Property Type Description
sysmapuserid ID 地图用户的 ID。

Property behavior:
- 只读
userid ID 用户的 ID。

Property behavior:
- 必填
permission integer 权限级别类型。

可能的值:
2 - 只读;
3 - 读写。

Property behavior:
- 必填

地图用户组

基于用户组的地图权限列表。它具有以下属性:

Property Type Description
sysmapusrgrpid ID 地图用户组的 ID。

Property behavior:
- read-only
usrgrpid ID 用户组的 ID。

Property behavior:
- required
permission integer 权限级别类型。

可选值:
2 - 只读;
3 - 读写。

Property behavior:
- required

地图形状

地图形状对象定义了显示在地图上的几何形状(带文本或不带文本)。 它具有以下属性:

Property Type Description
sysmap_shapeid ID 地图形状元素的 ID。

Property behavior:
- read-only
type integer 地图形状元素的类型。

可能的值:
0 - 矩形;
1 - 椭圆。

在创建新形状时,此属性为必填。

Property behavior:
- required
x integer 形状的 X 坐标,单位为像素。

默认值:0。
y integer 形状的 Y 坐标,单位为像素。

默认值:0。
width integer 形状的宽度,单位为像素。

默认值:200。
height integer 形状的高度,单位为像素。

默认值:200。
text string 形状的文本。
font integer 形状内文本的字体。

可能的值:
0 - Georgia, serif
1 - "Palatino Linotype", "Book Antiqua", Palatino, serif
2 - "Times New Roman", Times, serif
3 - Arial, Helvetica, sans-serif
4 - "Arial Black", Gadget, sans-serif
5 - "Comic Sans MS", cursive, sans-serif
6 - Impact, Charcoal, sans-serif
7 - "Lucida Sans Unicode", "Lucida Grande", sans-serif
8 - Tahoma, Geneva, sans-serif
9 - "Trebuchet MS", Helvetica, sans-serif
10 - Verdana, Geneva, sans-serif
11 - "Courier New", Courier, monospace
12 - "Lucida Console", Monaco, monospace

默认值:9。
font_size integer 字体大小,单位为像素。

默认值:11。
font_color string 字体颜色。

默认值:000000
text_halign integer 文本的水平对齐方式。

可能的值:
0 - 居中;
1 - 左对齐;
2 - 右对齐。

默认值:0。
text_valign integer 文本的垂直对齐方式。

可能的值:
0 - 垂直居中;
1 - 顶部;
2 - 底部。

默认值:0。
border_type integer 边框类型。

可能的值:
0 - 无;
1 - —————
2 - ·····
3 - - - -

默认值:0。
border_width integer 边框宽度,单位为像素。

默认值:0。
border_color string 边框颜色。

默认值:000000
background_color string 背景颜色(填充颜色)。

默认值:(empty)
zindex integer 用于对所有形状和线条进行排序的值(z-index)。

默认值:0。

地图线

地图线对象定义了在地图上显示的一条线。它具有以下属性:

Property Type Description
sysmap_shapeid ID 地图图形元素的 ID。

Property behavior:
- 只读
x1 integer 线段点 1 的 X 坐标,单位为像素。

默认值:0。
y1 integer 线段点 1 的 Y 坐标,单位为像素。

默认值:0。
x2 integer 线段点 2 的 X 坐标,单位为像素。

默认值:200。
y2 integer 线段点 2 的 Y 坐标,单位为像素。

默认值:200。
line_type integer 线条类型。

可选值:
0 - 无;
1 - —————
2 - ·····
3 - - - -

默认值:0。
line_width integer 线条宽度,单位为像素。

默认值:0。
line_color string 线条颜色。

默认值:000000
zindex integer 用于对所有图形和线条进行排序的值(z-index)。

默认值:0。