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.

Parámetro	Tipo	Descripción
graphids	ID/array	Devolver solo los gráficos con los IDs indicados.
groupids	ID/array	Devolver solo los gráficos que pertenecen a equipos o plantillas en los grupos de equipos o grupos de plantillas indicados.
templateids	ID/array	Devolver solo los gráficos que pertenecen a las plantillas indicadas.
hostids	ID/array	Devolver solo los gráficos que pertenecen a los equipos indicados.
itemids	ID/array	Devolver solo los gráficos que contienen las métricas indicadas.
templated	boolean	Si se establece en `true`, devolver solo los gráficos que pertenecen a plantillas.
inherited	boolean	Si se establece en `true`, devolver solo los gráficos heredados de una plantilla.
expandName	flag	Expandir macros en el nombre del gráfico.
selectDiscoveryData	query	Devolver una propiedad `discoveryData` con los datos del objeto de descubrimiento de gráficos. El objeto de descubrimiento de gráficos vincula un gráfico descubierto con un prototipo de gráfico del que fue descubierto. Tiene las siguientes propiedades: `parent_graphid` - `(ID)` ID del prototipo de gráfico del que se ha creado el gráfico; `lastcheck` - `(timestamp)` hora en la que el gráfico fue descubierto por última vez; `status` - `(int)` estado del descubrimiento del gráfico: 0 - (por defecto) el gráfico está descubierto, 1 - el gráfico ya no está descubierto; `ts_delete` - `(timestamp)` hora en la que se eliminará un gráfico que ya no está descubierto.
selectDiscoveryRule	query	Devolver una propiedad `discoveryRule` con la regla de bajo nivel de descubrimiento que creó el gráfico.
selectDiscoveryRulePrototype	query	Devolver una propiedad `discoveryRulePrototype` con el prototipo de regla LLD principal que creó el gráfico.
selectHostGroups	query	Devolver una propiedad `hostgroups` con los grupos de equipos a los que pertenece el gráfico.
selectTemplateGroups	query	Devolver una propiedad `templategroups` con los grupos de plantillas a los que pertenece el gráfico.
selectTemplates	query	Devolver una propiedad `templates` con las plantillas a las que pertenece el gráfico.
selectHosts	query	Devolver una propiedad `hosts` con los equipos a los que pertenece el gráfico.
selectItems	query	Devolver una propiedad `items` con las métricas utilizadas en el gráfico.
selectGraphDiscovery	query	Devolver una propiedad `graphDiscovery` con el objeto de descubrimiento de gráficos. Los objetos de descubrimiento de gráficos vinculan el gráfico con un prototipo de gráfico del que fue creado. Esta consulta está obsoleta, por favor use `selectDiscoveryData` en su lugar.
selectGraphItems	query	Devolver una propiedad `gitems` con las métricas utilizadas en el gráfico.
filter	object	Devolver solo aquellos resultados que coincidan exactamente con el filtro indicado. 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 del tipo de datos `text` data type. Admite propiedades adicionales: `host` - nombre técnico del equipo al que pertenece el gráfico; `hostid` - ID del equipo al que pertenece el gráfico.
sortfield	string/array	Ordenar el resultado por las propiedades indicadas. 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

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
       }

Véase también

Fuente

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

Documentation