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

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

El método admite los siguientes parámetros.

Parámetro	Tipo	Descripción
discoveryids	ID/array	Devolver solo los prototipos de gráficos que pertenecen a las reglas de descubrimiento indicadas.
graphids	ID/array	Devolver solo los prototipos de gráficos con los IDs indicados.
groupids	ID/array	Devolver solo los prototipos de gráficos que pertenecen a los equipos o plantillas en los grupos de equipos o grupos de plantillas indicados.
hostids	ID/array	Devolver solo los prototipos de gráficos que pertenecen a los equipos indicados.
inherited	booleano	Si se establece en `true`, devolver solo los prototipos de gráficos heredados de una plantilla.
itemids	ID/array	Devolver solo los prototipos de gráficos que contienen los prototipos de ítem indicados.
templated	booleano	Si se establece en `true`, devolver solo los prototipos de gráficos que pertenecen a plantillas.
templateids	ID/array	Devolver solo los prototipos de gráficos que pertenecen a las plantillas indicadas.
selectDiscoveryRule	consulta	Devolver una propiedad `discoveryRule` con la regla LLD a la que pertenece el prototipo de gráfico.
selectDiscoveryRulePrototype	consulta	Devolver una propiedad `discoveryRulePrototype` con el prototipo de regla LLD principal al que pertenece el prototipo de gráfico.
selectGraphItems	consulta	Devolver una propiedad `gitems` con los ítems de gráfico utilizados en el prototipo de gráfico.
selectHostGroups	consulta	Devolver una propiedad `hostgroups` con los grupos de equipos a los que pertenece el prototipo de gráfico.
selectHosts	consulta	Devolver una propiedad `hosts` con los equipos a los que pertenece el prototipo de gráfico.
selectItems	consulta	Devolver una propiedad `items` con los ítems y prototipos de ítem utilizados en el prototipo de gráfico.
selectTemplateGroups	consulta	Devolver una propiedad `templategroups` con los grupos de plantillas a los que pertenece el prototipo de gráfico.
selectTemplates	consulta	Devolver una propiedad `templates` con las plantillas a las que pertenece el prototipo de 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 prototipo de gráfico; `hostid` - ID del equipo al que pertenece el prototipo de gráfico.
sortfield	string/array	Ordenar el resultado por las propiedades indicadas. Valores posibles: `graphid`, `name`, `graphtype`, `discovered`.
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

Valores de retorno

(entero/matriz) Devuelve:

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

Ejemplos

Recuperar prototipos de gráficos de una regla LLD

Recuperar todos los prototipos de gráficos de una regla LLD.

Solicitud:

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

Respuesta:

{
           "jsonrpc": "2.0",
           "result": [
               {
                   "graphid": "1017",
                   "name": "Uso de espacio en disco {#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.

Documentation