map.get

描述

integer/array map.get(object parameters)

该方法允许根据给定的参数检索地图。

此方法可供任何类型的用户使用。调用该方法的权限 可以在用户角色设置中撤销。更多信息请参见 User roles

参数

(object) 定义所需输出的参数。

该方法支持以下参数。

参数 数据类型 说明
sysmapids ID/array 仅返回具有指定ID的地图。
userids ID/array 仅返回属于指定用户ID的地图。
expandUrls flag 将全局地图URL添加到相应的地图元素,并在所有地图元素URL中展开宏。
selectIconMap query 返回包含地图所使用的图标映射的iconmap属性。
selectLinks query 返回包含地图元素之间链接的links属性。
selectSelements query 返回包含地图元素的selements属性。
selectUrls query 返回包含地图URL的urls属性。
selectUsers query 返回包含地图共享用户的users属性。
selectUserGroups query 返回包含地图共享用户组的userGroups属性。
selectShapes query 返回包含地图形状的shapes属性。
selectLines query 返回包含地图线条的lines属性。
sortfield string/array 按照指定属性对结果进行排序。

可能的值:namewidthheight
countOutput boolean 这些参数在通用get方法参数中进行了描述。
editable boolean
excludeSearch boolean
filter object
limit integer
output query
preservekeys boolean
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean

返回值

(integer/array) 返回以下之一:

  • array 的 objects;
  • 如果使用了 countOutput 参数,则为检索到的 objects 的数量。

示例

检索地图

检索关于拓扑图 "3" 的所有数据。

执行请求:

{
           "jsonrpc": "2.0",
           "method": "map.get",
           "params": {
               "output": "extend",
               "selectSelements": "extend",
               "selectLinks": "extend",
               "selectUsers": "extend",
               "selectUserGroups": "extend",
               "selectShapes": "extend",
               "selectLines": "extend",
               "sysmapids": "3"
           },
           "id": 1
       }

响应:

{
           "jsonrpc": "2.0",
           "result": [
               {
                   "selements": [
                       {
                           "selementid": "10",
                           "sysmapid": "3",
                           "elementtype": "4",
                           "evaltype": "0",
                           "iconid_off": "1",
                           "iconid_on": "0",
                           "label": "Zabbix server",
                           "label_location": "3",
                           "x": "11",
                           "y": "141",
                           "iconid_disabled": "0",
                           "iconid_maintenance": "0",
                           "elementsubtype": "0",
                           "areatype": "0",
                           "width": "200",
                           "height": "200",
                           "tags": [
                               {
                                   "tag": "service",
                                   "value": "mysqld",
                                   "operator": "0"
                               }
                           ],
                           "viewtype": "0",
                           "use_iconmap": "1",
                           "urls": [],
                           "elements": []
                       },
                       {
                           "selementid": "11",
                           "sysmapid": "3",
                           "elementtype": "4",
                           "evaltype": "0",
                           "iconid_off": "1",
                           "iconid_on": "0",
                           "label": "Web server",
                           "label_location": "3",
                           "x": "211",
                           "y": "191",
                           "iconid_disabled": "0",
                           "iconid_maintenance": "0",
                           "elementsubtype": "0",
                           "areatype": "0",
                           "width": "200",
                           "height": "200",
                           "viewtype": "0",
                           "use_iconmap": "1",
                           "tags": [],
                           "urls": [],
                           "elements": []
                       },
                       {
                           "selementid": "12",
                           "sysmapid": "3",
                           "elementtype": "0",
                           "evaltype": "0",
                           "iconid_off": "185",
                           "iconid_on": "0",
                           "label": "{HOST.NAME}\r\n{HOST.CONN}",
                           "label_location": "0",
                           "x": "111",
                           "y": "61",
                           "iconid_disabled": "0",
                           "iconid_maintenance": "0",
                           "elementsubtype": "0",
                           "areatype": "0",
                           "width": "200",
                           "height": "200",
                           "viewtype": "0",
                           "use_iconmap": "0",
                           "tags": [],
                           "urls": [],
                           "elements": [
                               {
                                   "hostid": "10084"
                               }
                           ]
                       }
                   ],
                   "links": [
                       {
                           "linkid": "23",
                           "sysmapid": "3",
                           "selementid1": "10",
                           "selementid2": "11",
                           "drawtype": "0",
                           "color": "00CC00",
                           "label": "",
                           "linktriggers": []
                       }
                   ],
                   "users": [
                       {
                           "sysmapuserid": "1",
                           "userid": "2",
                           "permission": "2"
                       }
                   ],
                   "userGroups": [
                       {
                           "sysmapusrgrpid": "1",
                           "usrgrpid": "7",
                           "permission": "2"
                       }
                   ],
                   "shapes":[
                       {
                           "sysmap_shapeid":"1",
                           "type":"0",
                           "x":"0",
                           "y":"0",
                           "width":"680",
                           "height":"15",
                           "text":"{MAP.NAME}",
                           "font":"9",
                           "font_size":"11",
                           "font_color":"000000",
                           "text_halign":"0",
                           "text_valign":"0",
                           "border_type":"0",
                           "border_width":"0",
                           "border_color":"000000",
                           "background_color":"",
                           "zindex":"0"
                       }
                   ],
                   "lines":[
                       {
                           "sysmap_shapeid":"2",
                           "x1": 30,
                           "y1": 10,
                           "x2": 100,
                           "y2": 50,
                           "line_type": 1,
                           "line_width": 10,
                           "line_color": "009900",
                           "zindex":"1"
                       }
                   ],
                   "sysmapid": "3",
                   "name": "Local network",
                   "width": "400",
                   "height": "400",
                   "backgroundid": "0",
                   "label_type": "2",
                   "label_location": "3",
                   "highlight": "1",
                   "expandproblem": "1",
                   "markelements": "0",
                   "show_unack": "0",
                   "grid_size": "50",
                   "grid_show": "1",
                   "grid_align": "1",
                   "label_format": "0",
                   "label_type_host": "2",
                   "label_type_hostgroup": "2",
                   "label_type_trigger": "2",
                   "label_type_map": "2",
                   "label_type_image": "2",
                   "label_string_host": "",
                   "label_string_hostgroup": "",
                   "label_string_trigger": "",
                   "label_string_map": "",
                   "label_string_image": "",
                   "iconmapid": "0",
                   "expand_macros": "0",
                   "severity_min": "0",
                   "userid": "1",
                   "private": "1",
                   "show_suppressed": "1"
               }
           ],
           "id": 1
       }

另请参阅

来源

CMap::get() 在 ui/include/classes/api/services/CMap.php 中。