graphprototype.get

Descripción

integer/array graphprototype.get(object parameters)

El método permite recuperar prototipos de gráficos de acuerdo con los parámetros suministrados.

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
discoveryids	ID/matriz	Devuelve solo los prototipos de gráficos que pertenecen a las reglas de descubrimiento especificadas.
graphids	ID/matriz	Devuelve solo los prototipos de gráficos con los ID especificados.
groupids	ID/matriz	Devuelve solo los prototipos de gráficos que pertenecen a equipos o plantillas en los grupos de equipos o grupos de plantillas especificados.
hostids	ID/matriz	Devuelve solo los prototipos de gráficos que pertenecen a los equipos especificados.
inherited	booleano	Si se establece en `true`, devuelve solo los prototipos de gráficos heredados de una plantilla.
templated	boolean	Si se establece en `true`, devuelve solo los prototipos de gráficos que pertenecen a las plantillas.
templateids	ID/matriz	Devuelve solo los prototipos de grafos que pertenecen a las plantillas indicadas.
selectDiscoveryRule	query	Devuelve una propiedad `discoveryRule` con la regla LLD a la que pertenece el prototipo de grafo.
selectGraphItems	query	Devuelve una propiedad `gitems` con los elementos de grafo utilizados 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 equipos a los que pertenece el prototipo de gráfico.
selectItems	query	Devuelve una propiedad `items` con las métricas y los prototipos de métricas utilizados en el prototipo de grafo.
selectTemplateGroups	query	Devuelve una propiedad `templategroups` con los grupos de plantillas a los que pertenece el prototipo de grafo.
filter	object	Devuelve solo los resultados que coinciden exactamente con el filtro indicado. Acepta un objeto, donde las claves son nombres de propiedades y los valores son un valor único o una matriz de valores con los que comparar. No admite propiedades de tipo tipo de datos `text`. Admite propiedades adicionales: `host`: nombre técnico del equipo al que pertenece el prototipo de gráfico; `hostid`: ID del equipo al que pertenece el prototipo de gráfico.
sortfield	string/array	Ordena el resultado según las propiedades indicadas. Posibles valores: `graphid`, `name`, `graphtype`, `discovered`.
countOutput	booleano	Estos parámetros se describen en el comentario de referencia.
editable	booleano
excludeSearch	booleano
limit	integer
output	query
preservekeys	booleano
search	object
searchByAny	booleano
searchWildcardsEnabled	booleano
sortorder	string/array
startSearch	booleano

Valores de retorno

(entero/matriz) Devuelve:

una matriz de objetos;
el recuento de objetos recuperados, si el parámetro countOutput ha sido usado.

Ejemplos

Recuperación de prototipos de grafos de una regla LLD

Recuperar todos los prototipos de grafos de una regla LLD.

Solicitud:

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

Copy

✔ Copied

Respuesta:

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

Copy

✔ Copied

Ver también

Fuente

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

Documentation