Table of Contents
map.get
Descrição
integer/array map.get(object parameters)
O método permite recuperar mapas de acordo com os parâmetros fornecidos.
Este método está disponível para usuários de qualquer tipo. As permissões para chamar o método podem ser revogadas nas configurações de função do usuário. Veja Funções de usuário para mais informações.
Parâmetros
(object) Parâmetros que definem a saída desejada.
O método suporta os seguintes parâmetros.
| Parâmetro | Tipo | Descrição |
|---|---|---|
| sysmapids | ID/array | Retorna apenas mapas com os IDs fornecidos. |
| userids | ID/array | Retorna apenas mapas que pertencem aos IDs de usuário fornecidos. |
| expandUrls | flag | Adiciona URLs globais do mapa aos elementos de mapa correspondentes e expande macros em todas as URLs dos elementos do mapa. |
| selectIconMap | query | Retorna uma propriedade iconmap com o mapa de ícones usado no mapa. |
| selectLinks | query | Retorna uma propriedade links com os links do mapa entre elementos. |
| selectSelements | query | Retorna uma propriedade selements com os elementos do mapa. |
| selectUrls | query | Retorna uma propriedade urls com as URLs do mapa. |
| selectUsers | query | Retorna uma propriedade users com os usuários com os quais o mapa é compartilhado. |
| selectUserGroups | query | Retorna uma propriedade userGroups com os grupos de usuários com os quais o mapa é compartilhado. |
| selectShapes | query | Retorna uma propriedade shapes com as formas do mapa. |
| selectLines | query | Retorna uma propriedade lines com as linhas do mapa. |
| sortfield | string/array | Ordena o resultado pelas propriedades fornecidas. Valores possíveis: name, width, height. |
| countOutput | boolean | Esses parâmetros são descritos no comentário 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 |
Valores de retorno
(integer/array) Retorna:
- um array de objetos;
- a contagem de objetos recuperados, se o parâmetro
countOutputfoi usado.
Exemplos
Recuperar um mapa
Recupera todos os dados sobre o 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
}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",
"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
}Veja também
- Mapa de ícones
- Elemento do mapa
- Link do mapa
- URL do mapa
- Usuário do mapa
- Grupo de usuários do mapa
- Formas do mapa
- Linhas do mapa
Origem
CMap::get() em ui/include/classes/api/services/CMap.php.