Documentation
Table of Contents
graph.get
Descripción
integer/array graph.get(object parameters)
El método permite recuperar gráficos 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 |
|---|---|---|
| graphids | cadena/matriz | Devuelve solo gráficos con los ID proporcionados. |
| groupids | cadena/matriz | Devuelve solo gráficos que pertenecen a equipos o plantillas en los grupos de equipos o grupos de plantillas dados. |
| templateids | cadena/matriz | Devuelve solo el gráfico que pertenece a las plantillas dadas. |
| hostids | string/array | Devuelve sólo gráficos que pertenecen a los equipos dados. |
| itemids | string/array | Devuelve solo gráficos que contienen las métricas dadas. |
| templated | booleano | Si se establece en "verdadero", devuelve solo gráficos que pertenecen a plantillas. |
| inherited | booleano | Si se establece en "verdadero", solo se devuelven gráficos heredados de una plantilla. |
| expandName | flag | Ampliar macros en el nombre del gráfico. |
| selectHostGroups | query | Devuelve una propiedad hostgroups con los grupos de equipos a los que pertenece el gráfico. |
| selectTemplateGroups | query | Devuelve una propiedad templategroups con los grupos de plantillas a los que pertenece el gráfico. |
| selectTemplates | query | Devuelve una propiedad templates con las plantillas a las que pertenece el gráfico. |
| selectHosts | query | Devuelve una propiedad hosts con los equipos a los que pertenece el gráfico. |
| selectItems | query | Devuelve una propiedad items con las métricas utilizadas en el gráfico. |
| selectGraphDiscovery | query | Devuelve una propiedad graphDiscovery con el objeto de descubrimiento de gráficos. Los objetos de descubrimiento de gráficos vinculan el gráfico a un prototipo de gráfico a partir del cual se creó.Tiene las siguientes propiedades: graphid - (string) ID del gráfico;parent_graphid - (cadena) ID del prototipo del gráfico a partir del cual se creó el gráfico. |
| selectGraphItems | query | Devuelve una propiedad gitems con los elementos utilizados en el gráfico. |
| selectDiscoveryRule | query | Devuelve una propiedad discoveryRule con la regla de descubrimiento de bajo nivel que creó el gráfico. |
| filter | objeto | Devuelve sólo aquellos resultados que coinciden exactamente con el filtro dado. Acepta una matriz, donde las claves son nombres de propiedades y los valores son un valor único o una matriz de valores con los que comparar. Admite filtros adicionales: host: nombre técnico del equipo al que pertenece el gráfico;hostid: ID del equipo al que pertenece el gráfico. |
| sortfield | cadena/matriz | Ordena el resultado según las propiedades dadas. Valores posibles: graphid, name, graphtype. |
| countOutput | boolean | Estos parámetros, que son comunes para todos los métodos get, se describen en detalle en la página comentario de referencia. |
| editable | booleano | |
| excludeSearch | booleano | |
| limit | entero | |
| output | consulta | |
| preservekeys | booleano | |
| search | objeto | |
| searchByAny | booleano | |
| searchWildcardsEnabled | booleano | |
| sortorder | cadena/matriz | |
| startSearch | booleano | |
| selectGroups (obsoleto) |
query | Este parámetro está obsoleto; utilice selectHostGroups o selectTemplateGroups en su lugar.Devuelve una propiedad groups con los grupos de equipos y grupos de plantillas a los que pertenece el gráfico. |
Valores de retorno
(entero/matriz) Devuelve:
- una matriz de objetos;
- el recuento de objetos recuperados, si el parámetro
countOutputha sido usado.
Ejemplos
Recuperando gráficos de equipos
Recupere todos los gráficos del equipo "10107" y ordénelos por nombre.
{
"jsonrpc": "2.0",
"method": "graph.get",
"params": {
"output": "extend",
"hostids": 10107,
"sortfield": "name"
},
"id": 1
}Respuesta:
{
"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
}Ver también
- Regla de descubrimiento
- Elemento de gráfico
- Métrica
- Equipo
- Grupo de equipos
- Plantilla
- Grupo de plantillas
Fuente
CGraph::get() en ui/include/classes/api/services/CGraph.php.