拓扑图对象

以下对象与 拓扑图 API 直接相关。

拓扑图

拓扑图对象具有以下属性。

属性 类型 描述
sysmapid ID 拓扑图的 ID。

属性行为：
- 只读
- 更新操作时必填
height integer 拓扑图的高度（像素）。

属性行为：
- 创建操作时必填
name string 拓扑图名称。

属性行为：
- 创建操作时必填
width integer 拓扑图的宽度（像素）。

属性行为：
- 创建操作时必填
backgroundid ID 用作拓扑图背景的图像 ID。
background_scale integer 是否启用背景图像按比例缩放。

可能的值：
0 - 禁用缩放；
1 - (默认) 启用图像缩放。
expand_macros integer 配置拓扑图时，是否展开标签中的宏。

可能的值：
0 - (默认) 不展开宏；
1 - 展开宏。
expandproblem integer 对于只有一个问题的元素，是否显示问题触发器。

可能的值：
0 - 始终显示问题数量；
1 - (默认) 如果只有一个问题，则显示问题触发器。
grid_align integer 是否启用网格对齐。

可能的值：
0 - 禁用网格对齐；
1 - (默认) 启用网格对齐。
grid_show integer 是否在拓扑图上显示网格。

可能的值：
0 - 不显示网格；
1 - (默认) 显示网格。
grid_size integer 拓扑图网格大小（像素）。

支持的值：20、40、50、75 和 100。

默认值：50。
highlight integer 是否启用图标高亮。

可能的值：
0 - 禁用高亮；
1 - (默认) 启用高亮。
iconmapid ID 拓扑图中使用的图标映射 ID。
label_format integer 是否启用高级标签。

可能的值：
0 - (默认) 禁用高级标签；
1 - 启用高级标签。
label_location integer 拓扑图元素标签的位置。

可能的值：
0 - (默认) 底部；
1 - 左侧；
2 - 右侧；
3 - 顶部。
label_string_host string 主机元素的自定义标签。

属性行为：
- 如果 label_type_host 设置为“custom”，则必填
label_string_hostgroup string 主机组元素的自定义标签。

属性行为：
- 如果 label_type_hostgroup 设置为“custom”，则必填
label_string_image string 图像元素的自定义标签。

属性行为：
- 如果 label_type_image 设置为“custom”，则必填
label_string_map string 拓扑图元素的自定义标签。

属性行为：
- 如果 label_type_map 设置为“custom”，则必填
label_string_trigger string 触发器元素的自定义标签。

属性行为：
- 如果 label_type_trigger 设置为“custom”，则必填
label_type integer 拓扑图元素标签类型。

可能的值：
0 - 标签；
1 - IP 地址；
2 - (默认) 元素名称；
3 - 仅状态；
4 - 无。
label_type_host integer 主机元素的标签类型。

可能的值：
0 - 标签；
1 - IP 地址；
2 - (默认) 元素名称；
3 - 仅状态；
4 - 无；
5 - 自定义。
label_type_hostgroup integer 主机组元素的标签类型。

可能的值：
0 - 标签；
2 - (默认) 元素名称；
3 - 仅状态；
4 - 无；
5 - 自定义。
label_type_image integer 主机组元素的标签类型。

可能的值：
0 - 标签；
2 - (默认) 元素名称；
4 - 无；
5 - 自定义。
label_type_map integer 拓扑图元素的标签类型。

可能的值：
0 - 标签；
2 - (默认) 元素名称；
3 - 仅状态；
4 - 无；
5 - 自定义。
label_type_trigger integer 触发器元素的标签类型。

可能的值：
0 - 标签；
2 - (默认) 元素名称；
3 - 仅状态；
4 - 无；
5 - 自定义。
markelements integer 是否高亮最近状态发生变化的拓扑图元素。

可能的值：
0 - (默认) 不高亮元素；
1 - 高亮元素。
severity_min integer 将在拓扑图上显示的触发器的最低严重性。

有关支持的触发器严重性列表，请参见 触发器 severity 属性。
show_element_label integer 默认如何显示元素标签。

可能的值：
0 - 始终显示；
1 - (默认) 自动隐藏。
show_link_label integer 默认如何显示链路标签。

可能的值：
0 - 始终显示；
1 - (默认) 自动隐藏。
show_unack integer 应如何显示问题。

可能的值：
0 - (默认) 显示所有问题的计数；
1 - 仅显示未确认问题的计数；
2 - 分别显示已确认和未确认问题的计数。
userid ID 作为拓扑图所有者的用户 ID。
private integer 拓扑图共享类型。

可能的值：
0 - 公共拓扑图；
1 - (默认) 私有拓扑图。
show_suppressed integer 是否显示已抑制的问题。

可能的值：
0 - (默认) 隐藏已抑制的问题；
1 - 显示已抑制的问题。

地图元素

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

属性 类型 描述
selementid ID 地图元素的 ID。

属性行为：
- 只读
elements array 元素数据对象。

属性行为：
- 如果 elementtype 设置为“主机”、“地图”、“触发器”或“主机组”，则为必需
elementtype integer 地图元素的类型。

可能的值：
0 - 主机；
1 - 地图；
2 - 触发器；
3 - 主机组；
4 - 图像。

属性行为：
- 必需
iconid_off ID 用于以默认状态显示该元素的图像 ID。

属性行为：
- 必需
areatype integer 应如何显示主机组中的各个主机。

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

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

可能的值：
0 - (默认) And/Or；
2 - Or。
height integer 固定大小主机组元素的高度（像素）。

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

属性行为：
- 如果 elementtype 设置为“主机”、“地图”、“触发器”或“主机组”，则支持
iconid_maintenance ID 用于显示维护中的地图元素的图像 ID。

属性行为：
- 如果 elementtype 设置为“主机”、“地图”、“触发器”或“主机组”，则支持
iconid_on ID 用于显示存在问题的地图元素的图像 ID。

属性行为：
- 如果 elementtype 设置为“主机”、“地图”、“触发器”或“主机组”，则支持
label string 元素的标签。
label_location integer 地图元素标签的位置。

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

可能的值：
-1 - 无；
2 - 只读；
3 - 读写。
show_label integer 元素标签的显示方式。

可能的值：
-1 - (默认) 地图默认；
0 - 始终显示；
1 - 自动隐藏。
sysmapid ID 该元素所属地图的 ID。

属性行为：
- 只读
urls array 地图元素 URL。

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

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

可能的值：
0 - (默认) 网格。
width integer 固定大小主机组元素的宽度（像素）。

默认值：200。
x integer 元素的 X 坐标（像素）。

默认值：0。
y integer 元素的 Y 坐标（像素）。

默认值：0。
zindex integer 用于对地图元素进行排序的值（z-index）。

默认值：0。

地图元素主机

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

属性 Type 描述
hostid ID 主机的 ID。

地图元素主机组

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

属性 Type 说明
groupid ID 主机组的 ID。

地图元素 Map

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

属性 类型 描述
sysmapid ID 地图的 ID。

地图元素触发器

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

属性 Type 说明
triggerid ID 触发器的 ID。

地图元素标签

地图元素标签对象具有以下属性。

属性 类型 描述
tag string 地图元素标签名称。

属性行为：
- 必填
operator integer 地图元素标签条件运算符。

可能的值：
0 - (默认) 包含；
1 - 等于；
2 - 不包含；
3 - 不等于；
4 - 存在；
5 - 不存在。
value string 地图元素标签值。

地图元素 URL

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

属性 类型 描述
sysmapelementurlid ID 地图元素 URL 的 ID。

属性行为：
- 只读
name string 链接标题。

属性行为：
- 必需
url string 链接 URL。

属性行为：
- 必需
selementid ID 该 URL 所属地图元素的 ID。

地图链接

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

属性 类型 描述
linkid ID 地图链接的 ID。

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

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

属性行为：
- 必填
drawtype integer 链接线条的绘制样式。

可能的值：
0 - (默认) 实线；
2 - 粗线；
3 - 点线；
4 - 虚线。
color string 线条颜色，使用十六进制颜色代码表示。

默认值：000000。
label string 链接标签。
show_label integer 如何显示链接标签。

可能的值：
-1 - (默认) 地图默认值；
0 - 始终显示；
1 - 自动隐藏。
indicator_type integer 选择链接指示器类型。

可能的值：
0 - (默认) 静态链接；
1 - 触发器；
2 - 监控项值。
linktriggers array 用作链接状态指示器的地图链接触发器。

地图链接触发器对象的详细说明见下文。

属性行为：
- 如果 indicator_type 设置为“触发器”(1)，则为 必填。
itemid ID 监控项的 ID。

属性行为：
- 如果 indicator_type 设置为“监控项值”(2)，则为 必填。
highlights array 用作链接状态指示器的地图链接高亮。

地图链接指示器对象的详细说明见下文。

属性行为：
- 如果 indicator_type 设置为“监控项值”(2)，则为 必填。
thresholds array 用作链接状态指示器的地图链接阈值。

地图链接指示器对象的详细说明见下文。

属性行为：
- 如果 indicator_type 设置为“监控项值”(2)，则为 必填。
permission integer 权限级别类型。

可能的值：
-1 - 无；
2 - 只读；
3 - 读写。

地图链接触发器

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

属性 类型 描述
triggerid ID 用作链接指示器的触发器 ID。

属性行为：
- 必填
color string 指示器颜色，使用十六进制颜色代码表示。

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

可能的值：
0 - (默认) 线；
2 - 粗线；
3 - 点线；
4 - 虚线。

地图链接指示器

地图链接指示器对象基于监控项值定义地图链接状态指示器。它具有以下属性：

属性 类型 说明
pattern string 用于比较的正则表达式。仅适用于高亮。
sortorder integer 用于定义高亮的排序顺序。仅适用于高亮。
threshold string 用于比较的数值。仅适用于阈值。
drawtype integer 指示器绘制样式。

可能的值：
0 - (默认) 线；
2 - 粗线；
3 - 点线；
4 - 虚线。
color string 指示器颜色，以十六进制颜色代码表示。

默认值：DD0000。

属性行为：
- 必需

地图 URL

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

属性 Type 说明
sysmapurlid ID 地图 URL 的 ID。

属性行为：
- 只读
name string 链接标题。

属性行为：
- 必需
url string 链接 URL。

属性行为：
- 必需
elementtype integer URL 可用于哪种类型的地图元素。

支持的类型列表请参见地图元素 type 属性。

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

地图用户

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

属性 类型 描述
sysmapuserid ID 地图用户的 ID。

属性行为：
- 只读
userid ID 用户的 ID。

属性行为：
- 必需
permission integer 权限级别类型。

可能的值：
2 - 只读；
3 - 读写。

属性行为：
- 必需

地图用户组

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

属性 Type 描述
sysmapusrgrpid ID 地图用户组的 ID。

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

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

可能的值：
2 - 只读；
3 - 读写。

Property behavior：
- required

地图形状

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

属性 类型 说明
sysmap_shapeid ID 地图形状元素的 ID。

属性行为：
- 只读
type integer 地图形状元素的类型。

可能的值：
0 - 矩形；
1 - 椭圆。

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

属性行为：
- 必填
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。

地图连线

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

属性 类型 描述
sysmap_shapeid ID 地图形状元素的 ID。

属性行为：
- 只读
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。