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 | ID/array | Devolver solo los gráficos con los IDs dados. |
| groupids | ID/array | Devolver solo los gráficos que pertenecen a los equipos o plantillas en los grupos de equipos o grupos de plantillas dados. |
| templateids | ID/array | Devolver solo los gráficos que pertenecen a las plantillas dadas. |
| hostids | ID/array | Devolver solo los gráficos que pertenecen a los equipos dados. |
| itemids | ID/array | Devolver solo los gráficos que contienen los elementos dados. |
| templated | booleano | Si se establece en true, devolver solo los gráficos que pertenecen a plantillas. |
| inherited | booleano | Si se establece en true, devolver solo los gráficos heredados de una plantilla. |
| expandName | flag | Expandir macros en el nombre del gráfico. |
| selectHostGroups | consulta | Devolver una propiedad hostgroups con los grupos de equipos a los que pertenece el gráfico. |
| selectTemplateGroups | consulta | Devolver una propiedad templategroups con los grupos de plantillas a los que pertenece el gráfico. |
| selectTemplates | consulta | Devolver una propiedad templates con las plantillas a las que pertenece el gráfico. |
| selectHosts | consulta | Devolver una propiedad hosts con los equipos a los que pertenece el gráfico. |
| selectItems | consulta | Devolver una propiedad items con los elementos utilizados en el gráfico. |
| selectGraphDiscovery | consulta | Devolver 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 del que fue creado.Tiene las siguientes propiedades: graphid - (ID) ID del gráfico;parent_graphid - (ID) ID del prototipo de gráfico del que se creó el gráfico;lastcheck - (timestamp) hora en que el gráfico fue descubierto por última vez;status - (int) estado del descubrimiento del gráfico:0 - (por defecto) el gráfico está descubierto, 1 - el gráfico ya no está descubierto; ts_delete - (timestamp) hora en que se eliminará un gráfico que ya no está descubierto. |
| selectGraphItems | consulta | Devolver una propiedad gitems con los elementos utilizados en el gráfico. |
| selectDiscoveryRule | consulta | Devolver una propiedad discoveryRule con la regla de descubrimiento de bajo nivel que creó el gráfico. |
| filter | objeto | Devolver solo aquellos resultados que coincidan exactamente con el filtro dado. Acepta un objeto, donde las claves son nombres de propiedades y los valores son un único valor o un array de valores con los que comparar. No admite propiedades de tipo de dato text data type.Admite propiedades adicionales: host - nombre técnico del equipo al que pertenece el gráfico;hostid - ID del equipo al que pertenece el gráfico. |
| sortfield | string/array | Ordenar el resultado por las propiedades dadas. Valores posibles: graphid, name, graphtype. |
| countOutput | booleano | Estos parámetros se describen en el comentario de referencia. |
| editable | booleano | |
| excludeSearch | booleano | |
| limit | entero | |
| output | consulta | |
| preservekeys | booleano | |
| search | objeto | |
| searchByAny | booleano | |
| searchWildcardsEnabled | booleano | |
| sortorder | string/array | |
| startSearch | booleano | |
| selectGroups (obsoleto) |
consulta | Este parámetro está obsoleto, por favor use 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.