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/matriz	Devuelve solo prototipos de gráficos que pertenecen a las reglas de descubrimiento dadas.
graphids	ID/array	Devuelve solo prototipos de gráficos con los ID proporcionados.
groupids	ID/matriz	Devuelve solo prototipos de gráficos que pertenecen a equipos o plantillas en los grupos de equipos o grupos de plantillas dados.
hostids	ID/matriz	Devuelve solo prototipos de gráficos que pertenecen a los equipos dados.
heredado	booleano	Si se establece en "verdadero", devuelve solo los prototipos de gráficos heredados de una plantilla.
itemids	ID/array	Devuelve solo prototipos de gráficos que contienen los prototipos de métricas dados.
templado	booleano	Si se establece en "verdadero", devuelve solo prototipos de gráficos que pertenecen a plantillas.
templateids	ID/matriz	Devuelve solo prototipos de gráficos que pertenecen a las plantillas dadas.
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 del gráfico utilizados en el prototipo del gráfico.
selectHostGroups	query	Devuelve una propiedad `hostgroups` con los grupos de host a los que pertenece el prototipo de gráfico.
selectHosts	query	Devuelve una propiedad `hosts` con los hosts a los que pertenece el prototipo del gráfico.
selectItems	query	Devuelve una propiedad `items` con los items y item prototipos usados en el prototipo del gráfico .
selectTemplateGroups	query	Devuelve una propiedad `templategroups` con los grupos de plantillas a los que pertenece el prototipo de gráfico.
selectTemplates	query	Devuelve una propiedad `templates` con las plantillas a las que pertenece el prototipo de gráfico.
filter	objeto	Devuelve sólo aquellos resultados que coinciden exactamente con el filtro dado. 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 `text` tipo de datos. Admite propiedades adicionales: `host` - nombre técnico del host al que pertenece el prototipo del gráfico; `hostid` - ID del equipo al que pertenece el prototipo del gráfico.
sortfield	string/array	Ordena el resultado según las propiedades dadas. Valores posibles: `graphid`, `name`, `graphtype`.
countOutput	boolean	Estos parámetros, que son comunes para todos los métodos `get`, se describen en detalle en el comentario de referencia.
editable	booleano
excludeSearch	booleano
limit	entero
output	consulta
preservekeys	booleano
search	objeto
searchByAny	booleano
searchWildcardsEnabled	booleano
sortorder	cadena/matriz
startSearch	booleano
selectGroups (deprecated)	query	Este parámetro está en desuso, utilice `selectHostGroups` o `selectTemplateGroups` en su lugar. Devuelve una propiedad `groups` con los grupos de equipos y grupos de plantillas a los que pertenece el prototipo de 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

Recuperación de prototipos de gráficos a partir de una regla LLD

Recuperar todos los prototipos de gráficos a partir 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",
                   "parent_itemid": "27426",
                   "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.

Documentation