Documentation
Table of Contents
map.get
Descripción
integer/array map.get(object parameters)
El método permite recuperar mapas según los parámetros dados.
Este método está disponible para usuarios de cualquier tipo. Los permisos para llamar al método se pueden revocar en la configuración de roles de usuario. Ver Roles de usuario para más información.
Parámetros
(objeto) Parámetros que definen la salida deseada.
El método admite los siguientes parámetros.
| Parámetro | Tipo | Descripción |
|---|---|---|
| sysmapids | ID/array | Devuelve solo los mapas con los IDs indicados. |
| userids | ID/array | Devuelve solo los mapas que pertenecen a los IDs de usuario indicados. |
| expandUrls | flag | Agrega las URLs globales del mapa a los elementos de mapa correspondientes y expande las macros en todas las URLs de los elementos de mapa. |
| selectIconMap | query | Devuelve una propiedad iconmap con el mapa de iconos utilizado en el mapa. |
| selectLinks | query | Devuelve una propiedad links con los enlaces del mapa entre elementos. |
| selectSelements | query | Devuelve una propiedad selements con los elementos del mapa. |
| selectUrls | query | Devuelve una propiedad urls con las URLs del mapa. |
| selectUsers | query | Devuelve una propiedad users con los usuarios con los que se comparte el mapa. |
| selectUserGroups | query | Devuelve una propiedad userGroups con los grupos de usuarios con los que se comparte el mapa. |
| selectShapes | query | Devuelve una propiedad shapes con las formas del mapa. |
| selectLines | query | Devuelve una propiedad lines con las líneas del mapa. |
| sortfield | string/array | Ordena el resultado por las propiedades indicadas. Valores posibles: name, width, height. |
| countOutput | booleano | Estos parámetros se describen en el comentario de referencia. |
| editable | booleano | |
| excludeSearch | booleano | |
| filter | objeto | |
| limit | entero | |
| output | query | |
| preservekeys | booleano | |
| search | objeto | |
| searchByAny | booleano | |
| searchWildcardsEnabled | booleano | |
| sortorder | string/array | |
| startSearch | booleano |
Valores de retorno
(entero/matriz) Devuelve:
- una matriz de objetos;
- el recuento de objetos recuperados, si el parámetro
countOutputha sido usado.
Ejemplos
Recuperar un mapa
Recuperar todos los datos sobre el mapa "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
}Respuesta:
{
"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",
"viewtype": "0",
"use_iconmap": "1",
"show_label": "-1",
"zindex":"0",
"elements": [],
"urls": [],
"tags": [
{
"tag": "service",
"value": "mysqld",
"operator": "0"
}
]
},
{
"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",
"show_label": "0",
"zindex":"0",
"elements": [],
"urls": [],
"tags": []
},
{
"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",
"show_label": "1",
"zindex":"0",
"elements": [
{
"hostid": "10084"
}
],
"urls": [],
"tags": []
}
],
"links": [
{
"linkid": "23",
"sysmapid": "3",
"selementid1": "10",
"selementid2": "11",
"drawtype": "0",
"color": "00CC00",
"label": "",
"show_label": "1",
"indicator_type": "0",
"itemid": "0",
"linktriggers": [],
"thresholds": [],
"highlights": []
}
],
"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",
"background_scale": "1",
"label_type": "2",
"label_location": "3",
"show_element_label": "0",
"show_link_label": "1",
"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
}Ver también
- Mapa de iconos
- Elemento del mapa
- Enlace del mapa
- URL del mapa
- Usuario del mapa
- Grupo de usuarios del mapa
- Formas del mapa
- Líneas del mapa
Fuente
CMap::get() en ui/include/classes/api/services/CMap.php.