Documentation
Table of Contents
graph.get
Descrição
integer/array graph.get(object parameters)
O método permite recuperar gráficos 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 |
|---|---|---|
| graphids | ID/array | Retorna apenas gráficos com os IDs fornecidos. |
| groupids | ID/array | Retorna apenas gráficos que pertencem a hosts ou templates nos grupos de hosts ou grupos de templates fornecidos. |
| templateids | ID/array | Retorna apenas gráficos que pertencem aos templates fornecidos. |
| hostids | ID/array | Retorna apenas gráficos que pertencem aos hosts fornecidos. |
| itemids | ID/array | Retorna apenas gráficos que contêm os items fornecidos. |
| templated | boolean | Se definido como true, retorna apenas gráficos que pertencem a templates. |
| inherited | boolean | Se definido como true, retorna apenas gráficos herdados de um template. |
| expandName | flag | Expande macros no nome do gráfico. |
| selectHostGroups | query | Retorna uma propriedade hostgroups com os grupos de hosts aos quais o gráfico pertence. |
| selectTemplateGroups | query | Retorna uma propriedade templategroups com os grupos de templates aos quais o gráfico pertence. |
| selectTemplates | query | Retorna uma propriedade templates com os templates aos quais o gráfico pertence. |
| selectHosts | query | Retorna uma propriedade hosts com os hosts aos quais o gráfico pertence. |
| selectItems | query | Retorna uma propriedade items com os items usados no gráfico. |
| selectGraphDiscovery | query | Retorna uma propriedade graphDiscovery com o objeto de descoberta de gráfico. Os objetos de descoberta de gráfico vinculam o gráfico a um protótipo de gráfico a partir do qual ele foi criado.Possui as seguintes propriedades: graphid - (ID) ID do gráfico;parent_graphid - (ID) ID do protótipo de gráfico a partir do qual o gráfico foi criado;lastcheck - (timestamp) hora em que o gráfico foi descoberto pela última vez;status - (int) status da descoberta do gráfico:0 - (padrão) gráfico foi descoberto, 1 - gráfico não é mais descoberto; ts_delete - (timestamp) hora em que um gráfico que não é mais descoberto será excluído. |
| selectGraphItems | query | Retorna uma propriedade gitems com os items usados no gráfico. |
| selectDiscoveryRule | query | Retorna uma propriedade discoveryRule com a regra de descoberta de baixo nível que criou o gráfico. |
| filter | object | Retorna apenas os resultados que correspondem exatamente ao filtro fornecido. Aceita um objeto, onde as chaves são nomes de propriedades e os valores são um único valor ou um array de valores para comparar. Não suporta propriedades do tipo de dado text data type.Suporta propriedades adicionais: host - nome técnico do host ao qual o gráfico pertence;hostid - ID do host ao qual o gráfico pertence. |
| sortfield | string/array | Ordena o resultado pelas propriedades fornecidas. Valores possíveis: graphid, name, graphtype. |
| countOutput | boolean | Esses parâmetros são descritos no comentário de referência. |
| editable | boolean | |
| excludeSearch | boolean | |
| limit | integer | |
| output | query | |
| preservekeys | boolean | |
| search | object | |
| searchByAny | boolean | |
| searchWildcardsEnabled | boolean | |
| sortorder | string/array | |
| startSearch | boolean | |
| selectGroups (obsoleto) | query | Este parâmetro está obsoleto, por favor use selectHostGroups ou selectTemplateGroups em seu lugar.Retorna uma propriedade groups com os grupos de hosts e grupos de templates aos quais o gráfico pertence. |
Valores de retorno
(integer/array) Retorna:
- uma matriz de objetos;
- a contagem de objetos recuperados, se o parâmetro
countOutputtiver sido usado.
Exemplos
Recuperando gráficos de hosts
Recupere todos os gráficos do host "10107" e classifique-os por nome.
{ "jsonrpc": "2.0", "method": "graph.get", "params": { "output": "extend", "hostids": 10107, "sortfield": "name" }, "id": 1 }Resposta:
{ "jsonrpc": "2.0", "result": [ { "graphid": "612", "name": "CPU jumps", "width": "900", "height": "200", "yaxismin": "0", "yaxismax": "100", "templateid": "439", "show_work_period": "1", "show_triggers": "1", "graphtype": "0", "show_legend": "1", "show_3d": "0", "percent_left": "0", "percent_right": "0", "ymin_type": "0", "ymax_type": "0", "ymin_itemid": "0", "ymax_itemid": "0", "flags": "0" }, { "graphid": "613", "name": "CPU load", "width": "900", "height": "200", "yaxismin": "0", "yaxismax": "100", "templateid": "433", "show_work_period": "1", "show_triggers": "1", "graphtype": "0", "show_legend": "1", "show_3d": "0", "percent_left": "0", "percent_right": "0", "ymin_type": "1", "ymax_type": "0", "ymin_itemid": "0", "ymax_itemid": "0", "flags": "0" }, { "graphid": "614", "name": "CPU utilization", "width": "900", "height": "200", "yaxismin": "0", "yaxismax": "100", "templateid": "387", "show_work_period": "1", "show_triggers": "0", "graphtype": "1", "show_legend": "1", "show_3d": "0", "percent_left": "0", "percent_right": "0", "ymin_type": "1", "ymax_type": "1", "ymin_itemid": "0", "ymax_itemid": "0", "flags": "0" }, { "graphid": "645", "name": "Disk space usage /", "width": "600", "height": "340", "yaxismin": "0", "yaxismax": "0", "templateid": "0", "show_work_period": "0", "show_triggers": "0", "graphtype": "2", "show_legend": "1", "show_3d": "1", "percent_left": "0", "percent_right": "0", "ymin_type": "0", "ymax_type": "0", "ymin_itemid": "0", "ymax_itemid": "0", "flags": "4" } ], "id": 1 }Veja também
Fonte
CGraph::get() em ui/include/classes/api/services/CGraph.php.