You are viewing documentation for the development version, it may be incomplete.
Join our translation project and help translate Zabbix documentation into your native language.

map.get

Descripció

integer/array map.get(object parameters)

El mètode permet recuperar mapes segons els paràmetres proveïts.

Aquest mètode és disponible per a usuaris de qualsevol mena. Els permisos per cridar al mètode es poden revocar a les configuracions de rols d'usuari. Per a més informació, veieu Rols d'usuari.

Paràmetres

(object) Paràmetres que defineixen la sortida esperada.

El mètode admet els paràmetres següents.

Paràmetre Tipus Descripció
sysmapids ID/array Retorna només mapes amb els identificadors donats.
userids ID/array Retorna només les targes que pertanyen als ID d'usuari donats.
expandUrls flag Afegeix URL de mapa global als elements de mapa corresponents i amplia les macros a totes les URL d'elements de mapa.
selectIconMap query Retorna la propietat mapa d'icones que conté els mapes d'icones emprats al mapa.
selectLinks query Retorna la propietat enllaçps que conté els enllaços del mapa entre els elements.
selectSelements query Retorna la propietat selements que conté els elements del mapa.
selectUrls query Retorna la propietat urls que conté els URL del mapa.
selectUsers query Retorna la propietat usuaris que conté els usuaris amb els quals es comparteix el mapa.
selectUserGroups query Retorna la propietat grups d'usuaris que conté els grups d'usuaris amb què es comparteix el mapa.
selectShapes query Retorna la propietat formes que conté les formes del mapa.
selectLines query Retorna la propietat línies que conté les línies del mapa.
sortfield string/array Ordena el resultat per les propietats donades.

Els valors possibles són: name, width i height.
countOutput boolean Aquests paràmetres, comuns a tots els mètodes get, es descriuen als comentaris de referència.
editable boolean
excludeSearch boolean
filter object
limit integer
output query
preservekeys boolean
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean

Valors de retorn

(integer/array) Retorna un d'entre:

  • una taula d'objectes;
  • el recompte d'objectes recuperats, si s'empra el paràmetre countOutput.

Exemples

Recuperar un mapa

Recuperar totes les dades relatives al mapa "3".

Petició:

{
           "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
       }

Resposta:

{
           "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
       }

Veieu també

  • Icones de mapa
  • [Element del mapa] (object#map_element)
  • Enllaç del mapa
  • [URL del mapa] (object#map_url)
  • [Usuari del mapa] (object#map_user)
  • [Grup d'usuaris del mapa] (object#map_user_group)
  • [Formes del mapa] (object#map_shapes)
  • [Línies del mapa] (object#map_lines)

Font

CMap::get() in ui/include/classes/api/services/CMap.php.