graph.get

Descripción

integer/array graph.get(object parameters)

El método permite recuperar gráficos según los parámetros proporcionados.

Este método está disponible para usuarios de cualquier tipo. Los permisos para llamar al método pueden ser revocados en la configuración de roles de usuario. Consulte Roles de usuario para obtener más información.

Parámetros

(object) Parámetros que definen la salida deseada.

El método admite los siguientes parámetros.

Parameter Type Description
graphids ID/array Devuelve solo los graphs con los IDs dados.
groupids ID/array Devuelve solo los graphs que pertenecen a hosts o templates en los grupos de hosts o grupos de templates dados.
templateids ID/array Devuelve solo los graphs que pertenecen a los templates dados.
hostids ID/array Devuelve solo los graphs que pertenecen a los hosts dados.
itemids ID/array Devuelve solo los graphs que contienen los items dados.
templated boolean Si se establece en true, devuelve solo los graphs que pertenecen a templates.
inherited boolean Si se establece en true, devuelve solo los graphs heredados de un template.
expandName flag Expande las macros en el nombre del graph.
selectHostGroups query Devuelve una propiedad hostgroups con los grupos de hosts a los que pertenece el graph.
selectTemplateGroups query Devuelve una propiedad templategroups con los grupos de templates a los que pertenece el graph.
selectTemplates query Devuelve una propiedad templates con los templates a los que pertenece el graph.
selectHosts query Devuelve una propiedad hosts con los hosts a los que pertenece el graph.
selectItems query Devuelve una propiedad items con los items usados en el graph.
selectGraphDiscovery query Devuelve una propiedad graphDiscovery con el objeto de descubrimiento del graph. Los objetos de descubrimiento del graph vinculan el graph con un prototipo de graph a partir del cual se creó.

Tiene las siguientes propiedades:
graphid - (ID) ID del graph;
parent_graphid - (ID) ID del prototipo de graph a partir del cual se creó el graph;
lastcheck - (timestamp) hora en que se descubrió por última vez el graph;
status - (int) estado del descubrimiento del graph:
0 - (predeterminado) el graph está descubierto,
1 - el graph ya no está descubierto;
ts_delete - (timestamp) hora en que se eliminará un graph que ya no esté descubierto.
selectGraphItems query Devuelve una propiedad gitems con los items usados en el graph.
selectDiscoveryRule query Devuelve una propiedad discoveryRule con la regla de descubrimiento de bajo nivel que creó el graph.
filter object Devuelve solo aquellos resultados que coinciden 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 datos text data type.

Admite propiedades adicionales:
host - nombre técnico del host al que pertenece el graph;
hostid - ID del host al que pertenece el graph.
sortfield string/array Ordena el resultado por las propiedades dadas.

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
(deprecated)		 query Este parámetro está obsoleto; 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 graph.

Valores de retorno

(integer/array) Devuelve:

  • un array de objetos;
  • el número de objetos recuperados, si se ha utilizado el parámetro countOutput.

Ejemplos

Recuperar gráficos de equipos

Recuperar todos los gráficos del equipo "10107" y ordenarlos 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": "Carga de CPU",
            "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": "Utilización de CPU",
            "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": "Uso de espacio en disco /",
            "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.