graphprototype.get

Descripción

integer/array graphprototype.get(object parameters)

El método permite recuperar prototipos de 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 pueden ser revocados en la configuración del rol 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
discoveryids ID/array Devuelve solo los prototipos de gráfico que pertenecen a las reglas de descubrimiento dadas.
graphids ID/array Devuelve solo los prototipos de gráfico con los IDs dados.
groupids ID/array Devuelve solo los prototipos de gráfico que pertenecen a hosts o templates en los grupos de hosts o grupos de templates dados.
hostids ID/array Devuelve solo los prototipos de gráfico que pertenecen a los hosts dados.
inherited boolean Si se establece en true, devuelve solo los prototipos de gráfico heredados de un template.
itemids ID/array Devuelve solo los prototipos de gráfico que contienen los prototipos de item dados.
templated boolean Si se establece en true, devuelve solo los prototipos de gráfico que pertenecen a templates.
templateids ID/array Devuelve solo los prototipos de gráfico que pertenecen a los templates dados.
selectDiscoveryRule query Devuelve una propiedad discoveryRule con la regla LLD a la que pertenece el prototipo de gráfico.
selectGraphItems query Devuelve una propiedad gitems con los elementos de gráfico usados en el prototipo de gráfico.
selectHostGroups query Devuelve una propiedad hostgroups con los grupos de hosts a los que pertenece el prototipo de gráfico.
selectHosts query Devuelve una propiedad hosts con los hosts a los que pertenece el prototipo de gráfico.
selectItems query Devuelve una propiedad items con los items y prototipos de item usados en el prototipo de gráfico.
selectTemplateGroups query Devuelve una propiedad templategroups con los grupos de templates a los que pertenece el prototipo de gráfico.
selectTemplates query Devuelve una propiedad templates con los templates a los que pertenece el prototipo de gráfico.
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 prototipo de gráfico;
hostid - ID del host al que pertenece el prototipo de gráfico.
sortfield string/array Ordena el resultado por las propiedades dadas.

Valores posibles: graphid, name, graphtype, discovered.
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 prototipo de gráfico.

Valores de retorno

(entero/array) Devuelve:

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

Ejemplos

Recuperación de prototipos de gráfico de una regla LLD

Recupere todos los prototipos de gráfico de una regla LLD.

Request:

{
    "jsonrpc": "2.0",
    "method": "graphprototype.get",
    "params": {
        "output": "extend",
        "discoveryids": "27426"
    },
    "id": 1
}

Response:

{
    "jsonrpc": "2.0",
    "result": [
        {
            "graphid": "1017",
            "name": "Disk space usage {#FSNAME}",
            "width": "600",
            "height": "340",
            "yaxismin": "0.0000",
            "yaxismax": "0.0000",
            "templateid": "442",
            "show_work_period": "0",
            "show_triggers": "0",
            "graphtype": "2",
            "show_legend": "1",
            "show_3d": "1",
            "percent_left": "0.0000",
            "percent_right": "0.0000",
            "ymin_type": "0",
            "ymax_type": "0",
            "ymin_itemid": "0",
            "ymax_itemid": "0",
            "discover": "0"
        }
    ],
    "id": 1
}

Ver también

Fuente

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