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

(object) 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 indicados.
groupids ID/array Devolver solo los gráficos que pertenezcan a hosts o templates en los grupos de hosts o grupos de templates indicados.
templateids ID/array Devolver solo los gráficos que pertenezcan a los templates indicados.
hostids ID/array Devolver solo los gráficos que pertenezcan a los hosts indicados.
itemids ID/array Devolver solo los gráficos que contengan los items indicados.
templated boolean Si se establece en true, devolver solo los gráficos que pertenezcan a templates.
inherited boolean Si se establece en true, devolver solo los gráficos heredados de un template.
expandName flag Expandir macros en el nombre del gráfico.
selectHostGroups query Devolver una propiedad hostgroups con los grupos de hosts a los que pertenece el gráfico.
selectTemplateGroups query Devolver una propiedad templategroups con los grupos de templates a los que pertenece el gráfico.
selectTemplates query Devolver una propiedad templates con los templates a los que pertenece el gráfico.
selectHosts query Devolver una propiedad hosts con los hosts a los que pertenece el gráfico.
selectItems query Devolver una propiedad items con los items utilizados en el gráfico.
selectGraphDiscovery query Devolver una propiedad graphDiscovery con el objeto de descubrimiento de gráficos. Los objetos de descubrimiento de gráficos vinculan el gráfico a una plantilla de gráfico a partir de la cual se creó.

Tiene las siguientes propiedades:
graphid - (ID) ID del gráfico;
parent_graphid - (ID) ID de la plantilla de gráfico a partir de la cual se creó el gráfico;
lastcheck - (timestamp) hora en que se descubrió por última vez el gráfico;
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 se descubre.
selectGraphItems query Devolver una propiedad gitems con los items utilizados en el gráfico.
selectDiscoveryRule query Devolver una propiedad discoveryRule con la regla de descubrimiento de bajo nivel que creó el gráfico.
filter object 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 host al que pertenece el gráfico;
hostid - ID del host al que pertenece el gráfico.
sortfield string/array Ordenar el resultado por las propiedades indicadas.

Valores posibles: graphid, name, graphtype.
countOutput boolean Estos parámetros se describen en el comentario de referencia.
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 utilice selectHostGroups o selectTemplateGroups en su lugar.
Devuelve una propiedad groups con los grupos de hosts y grupos de templates 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 countOutput ha sido usado.

Ejemplos

Recuperando gráficos de equipos

Recupere todos los gráficos del equipo "10107" y ordénelos por nombre.

Solicitud:

{
    "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

Fuente

CGraph::get() en ui/include/classes/api/services/CGraph.php.