Se encuentra viendo la documentación de la versión en desarrollo, puede estar incompleta.
Únase a nuestro proyecto de traducción y ayude a traducir la documentación de Zabbix a su lengua materna.

service.get

Descripción

integer/array service.get(object parameters)

El método permite recuperar servicios de acuerdo con los parámetros dados.

Este método está disponible para usuarios de cualquier tipo. Los permisos para llamar al método se puede revocar en la configuración de roles de usuario. Ver Roles de usuario para obtener 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
serviceids cadena/matriz Devuelve solo servicios con los ID proporcionados.
parentids cadena/matriz Devuelve solo los servicios que están vinculados a los servicios principales dados.
deep_parentids flag Devuelve todos los servicios secundarios directos e indirectos. Usado junto con parentids.
childids cadena/matriz Devuelve sólo los servicios que están vinculados a los servicios secundarios dados.
evaltype entero Reglas para la búsqueda de etiquetas.

Valores posibles:
0 - (predeterminado) Y/O;
2 - O.
tags objeto/matriz Devuelve solo servicios con etiquetas dadas. Coincidencia exacta por etiqueta y búsqueda que distinga entre mayúsculas y minúsculas por valor de etiqueta según el valor del operador.
Formato: [{"tag": "<tag>", "value": "<value>", " operador": "<operador>"}, ...].
Una matriz vacía devuelve todos los servicios.

Valores posibles del operador:
0 - (predeterminado) Contiene;<br >1 - Es igual;
2 - No contiene;
3 - No es igual;
4 - Existe;
5 - No existe.
problem_tags objeto/matriz Devuelve solo servicios con etiquetas de problema dadas. Coincidencia exacta por etiqueta y búsqueda que distinga entre mayúsculas y minúsculas por valor de etiqueta según el valor del operador.
Formato: [{"tag": "<tag>", "value": "<value>", " operador": "<operador>"}, ...].
Una matriz vacía devuelve todos los servicios.

Valores posibles del operador:
0 - (predeterminado) Contiene;<br >1 - Es igual;
2 - No contiene;
3 - No es igual;
4 - Existe;
5 - No existe.
without_problem_tags flag Devolver solo servicios sin etiquetas de problema.
slaids cadena/matriz Devuelve sólo los servicios que están vinculados a los SLA específicos.
selectChildren query Devuelve una propiedad children con los servicios secundarios.

Admite count.
selectParents consulta Devuelve una propiedad parents con los servicios principales.

Admite count.
selectTags query Devuelve una propiedad tags con etiquetas de servicio.

Admite count.
selectProblemEvents query Devuelve una propiedad problem_events con una matriz de objetos de evento de problema.

El objeto de evento de problema tiene las siguientes propiedades:
eventid - (string) ID de evento;< br>severity - (string) Gravedad del evento actual;
name - (string) Nombre del evento resuelto.

Admite count.
selectProblemTags query Devuelve una propiedad problem_tags con etiquetas de problema.

Admite count.
selectStatusRules query Devuelve una propiedad status_rules con reglas de estado.

Admite count.
selectStatusTimeline object/array Devuelve una propiedad status_timeline que contiene cambios en el estado del servicio para períodos determinados.

Formato [{"period_from": "<period_from>", "period_to": "<period_to>" }, ...] - period_from es una fecha de inicio (inclusive; marca de tiempo entera) y period_to es una fecha de finalización (exclusiva; marca de tiempo entera) para el período que le interesa.

Devuelve una matriz de entradas que contiene una propiedad start_value y una matriz alarms para los cambios de estado dentro de períodos específicos.
sortfield string/array Ordena el resultado según las propiedades dadas.

Valores posibles: serviceid, name, status, sortorder, created_at.
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
filter objeto
limit entero
output consulta
preservekeys booleano
search objeto
searchByAny booleano
searchWildcardsEnabled booleano
sortorder cadena/matriz
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

Recuperando todos los servicios

Recupere todos los datos sobre todos los servicios y sus dependencias.

Solicitud:

{
           "jsonrpc": "2.0",
           "method": "service.get",
           "params": {
               "output": "extend",
               "selectChildren": "extend",
               "selectParents": "extend"
           },
           "id": 1
       }

Respuesta:

{
           "jsonrpc": "2.0",
           "result": [
               {
                   "serviceid": "1",
                   "name": "My Service - 0001",
                   "status": "-1",
                   "algorithm": "2",
                   "sortorder": "0",
                   "weight": "0",
                   "propagation_rule": "0",
                   "propagation_value": "0",
                   "description": "My Service Description 0001.",
                   "uuid": "dfa4daeaea754e3a95c04d6029182681",
                   "created_at": "946684800",
                   "readonly": false,
                   "parents": [],
                   "children": []
               },
               {
                   "serviceid": "2",
                   "name": "My Service - 0002",
                   "status": "-1",
                   "algorithm": "2",
                   "sortorder": "0",
                   "weight": "0",
                   "propagation_rule": "0",
                   "propagation_value": "0",
                   "description": "My Service Description 0002.",
                   "uuid": "20ea0d85212841219130abeaca28c065",
                   "created_at": "946684800",
                   "readonly": false,
                   "parents": [],
                   "children": []
               }
           ],
           "id": 1
       }

Fuente

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