Sidebar

zh:manual:api:reference:map:object

> 对象

以下内容是关于拓扑图 map API.

Map 拓扑图

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

Property Type Description
sysmapid string (readonly) 拓扑图ID。
height
(required)
integer 拓扑图画布高度。
name
(required)
string 拓扑图名称。
width
(required)
integer 拓扑图宽度。
backgroundid string 拓扑图背景图像ID。
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 string 拓扑图使用图表的ID。
label_format integer 是否启用高级标签。

可能的值:
0是不用
1是使用
label_location integer 拓扑图标签的位置。

可能的值:
0是底部
1是左边
2是右边
3是顶部
label_string_host string 主机元素自定义标签。

需要拓扑图中的主机自定义标签类型。
label_string_hostgroup string 主机组元素自定义标签。

需要拓扑图中的主机组自定义标签类型。
label_string_image string 图像元素自定义标签。

图像元素的自定义标签。
label_string_map string 拓扑图元素自定义标签。

拓扑图元素自定义标签。
label_string_trigger string 触发器元素自定义标签

触发器元素自定义标签。
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:标签
1:ip地址
2:元素名称(默认)
3:状态
4:没有
5:自定义
label_type_image integer 图像元素的标签类型

可能的值:
0:标签
1:ip地址
2:元素名称(默认)
3:状态
4:没有
5:自定义
label_type_map integer 拓扑图元素的标签类型

可能的值:
0:标签
1:ip地址
2:元素名称(默认)
3:状态
4:没有
5:自定义
label_type_trigger integer 触发器元素的标签类型

可能的值:
0:标签
1:ip地址
2:元素名称(默认)
3:状态
4:没有
5:自定义
markelements integer 是否突出显示最近更改其状态的拓扑图元素

可能的值:
0:不高亮
1:显示高亮
severity_min integer 显示在拓扑图上的严重程度最小触发器。

参考trigger "severity" property,获取支持的触发器严重程度列表。
show_unack integer 如何显示问题。

可能的值:
0:(默认)显示所有问题的总数
1:仅显示未确认问题的总数
2:分别显示已确认和未确认的数目
userid string 拓扑图所有用户的ID
private integer 拓扑图的共享类型

可能的值:
0:公共的拓扑图
1:(默认)私有的拓扑图

拓扑图元素

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

Property Type Description
selementid string (只读) 拓扑图元素的ID
elements
(required)
array 元素数据对象。

需要主机、主机组、触发器和拓扑图类型元素。
elementtype
(required)
integer 拓扑图元素类型。

可能的值:
0-主机
1-拓扑图
2-触发器
3-主机组
4-图像
iconid_off
(required)
string 用于在默认状态下显示元素的图像的ID。
areatype integer 应该如何显示独立的主机组主机。

可能的值
0-(默认)主机组元素占用整个拓扑图
1-主机组元素的大小是固定的
application string 显示问题的应用程序的名称。只用于主机和主机组映射元素。
elementsubtype integer 一个主机组元素如何显示在拓扑图上

可能的值:
0-(默认)显示主机组作为一个单独的元素
1-分别显示组中的每个主机
height integer 固定大小的主机组元素的高度(以像素为单位)。

默认是:200
iconid_disabled string 用于显示禁用映射元素的图像的ID。未使用的图像元素。
iconid_maintenance string 用于显示维护中的拓扑图元素的图像的ID。未使用的图像元素。
iconid_on string 用于显示有问题的拓扑图元素的图像的ID。未使用的图像元素。
label string 元素的标签
label_location integer 拓扑元素标签的位置。

可能的值:
-1: 默认的位置
0-底部
1-左边
2-右边
3-上边
permission integer 类型的权限级别。

可能的值:
1:-没有权限
2-只读权限
3-读写权限
sysmapid string (只读) 元素所述拓扑图的ID
urls array 拓扑图元素的URL 。

The map element URL object is described in detail below.
use_iconmap integer 是否必须为主机元素使用图标映射。

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

可能的值:
0-网格
width integer 主机组元素固定的像素宽度。

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

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

默认是:0

拓扑图元素的主机

拓扑图元素中的主机对象定义是一个主机元素。

Property Type Description
hostid string Host ID

拓扑图元素中的主机组

拓扑图元素中的主机组对象定义是一个主机组元素。

Property Type Description
groupid string Host group ID

拓扑图元素中的拓扑图

拓扑图元素中的拓扑图对象默认是一个拓扑图元素。

Property Type Description
sysmapid string Map ID

拓扑图元素中的触发器

拓扑图元素中的触发器对象定义的是一个或者多个触发器元素。

Property Type Description
triggerid string Trigger ID

拓扑图元素中的URL

拓扑图元素URL对象定义了一个可单击的链接,该链接将对特定的map元素可用。它具有以下特性:

Property Type Description
sysmapelementurlid string (readonly) ID of the map element URL.
name
(required)
string Link caption.
url
(required)
string Link URL.
selementid string ID of the map element that the URL belongs to.

拓扑图关联

拓扑图链接对象定义两个映射元素之间的链接。它具有以下属性。

Property Type Description
linkid string (readonly) ID of the map link.
selementid1
(required)
string 在一端连接的第一个拓扑图元素的ID。
selementid2
(required)
string 另一端连接的第一个拓扑图元素的ID。
color string 行颜色作为十六进制颜色代码。

默认是:“000000”
drawtype integer 链接线画的风格。

可能的值:0-线(默认)2-粗线 3-点线 4-虚线
label string 行标签
linktriggers array 拓扑图链接触发器用作链接状态指示器。
permission integer 权限等级类型

可能的值: -1-没有 2-只读 3-可读可写
sysmapid string 该关联所属拓扑图ID

拓扑图关联触发器

拓扑图链接触发器对象根据触发器的状态定义一个拓扑图链接状态指示器。它具有以下特性:

Property Type Description
linktriggerid string (readonly) ID of the map link trigger.
triggerid
(reqiuired)
string ID of the trigger used as a link indicator.
color string Indicator color as a hexadecimal color code.

Default: DD0000.
drawtype integer 指标画的风格

可能的值: 0-线(默认)2-粗线 3-点线 4-虚线
linkid string 关联触发器所属拓扑图ID。

拓扑图URL

拓扑图URL对象定义了一个可单击的链接,该链接可用于映射上特定类型的所有元素。它具有以下特性:

Property Type Description
sysmapurlid string (只读) 拓扑图URL ID
name
(required)
链接标题。
url
(required)
string 链接URL
elementtype integer 拓扑图元素可用URL类型

默认:0
sysmapid string 所属URL的拓扑图ID

拓扑图用户

基于用户的拓扑图权限列表。它具有以下特性:

Property Type Description
sysmapuserid string (只读) 拓扑图用户ID。
userid
(required)
string User ID.
permission
(required)
integer 权限等级类型

可能的值:
-1-没有
2-只读
3-可读可写

拓扑图用户组

基于用户组的拓扑图权限列表。它具有以下特性:

Property Type Description
sysmapusrgrpid string (只读) 拓扑图用户组的ID
usrgrpid
(required)
string User group ID.
permission
(required)
integer 权限等级类型

可能的值:
-1-没有
2-只读
3-可读可写

地图形状

拓扑图形状对象定义了显示在拓扑图上的几何形状(包含或不包含文本)。它具有以下特性:

Property Type Description
sysmap_shapeid string (readonly) 拓扑图形状元素的ID
type (required) integer 拓扑图形状元素的类型

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

创建新形状时需要属性。
x integer 元素的x坐标,单位为像素。

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

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

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

默认是:200
text string 文本的形状。
font integer Font of the text within shape.

可能的值:
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-右边
text_valign integer 垂直对齐文本

可能的值:
0-中间(默认)
1-顶部
2-底部
border_type integer 边界类型

可能的值:
0-没有(默认)
1 - —————
2 - ·····
3 - - - -
border_width integer 边框的宽度,以像素为单位

默认:0
border_color string 边界的颜色

默认:‘000000’
background_color string 背景颜色(填充颜色)

默认是:无
zindex integer 用于定制形状的值(z-index)。

默认是:0

拓扑图线

拓扑图线对象定义显示在拓扑图上的行。它具有以下特性:

Property Type Description
sysmap_shapeid string (只读) 拓扑图形状元素的ID
x1 integer 以像素为单位的直线点1的x坐标。

默认是:0
y1 integer 以像素为单位的直线点1的y坐标。

默认是:0
x2 integer 以像素为单位的直线点2的x坐标。

默认是:200
y2 integer 以像素为单位的直线点2的x坐标。

默认是:200
line_type integer 边界类型

可能的值:
0-没有(默认) 1 - ————— 2 - ····· 3 - - - -
line_width integer 边框的宽度,以像素为单位

默认:0
line_color string 边界的颜色

默认:‘000000’
zindex integer 用于定制形状的值(z-index)。

默认是:0