Table of Contents
service.get
Descripción
integer/array service.get(object parameters)
El método permite recuperar servicios según los parámetros dados.
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 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 |
|---|---|---|
| serviceids | ID/array | Devolver solo los servicios con los IDs dados. |
| parentids | ID/array | Devolver solo los servicios que están vinculados a los servicios padre dados. |
| deep_parentids | flag | Devolver todos los servicios hijos directos e indirectos. Se utiliza junto con parentids. |
| childids | ID/array | Devolver solo los servicios que están vinculados a los servicios hijos dados. |
| evaltype | integer | Método de evaluación de la etiqueta. Valores posibles: 0 - (por defecto) Y/O; 2 - O. |
| tags | object/array | Devolver solo los servicios con las etiquetas dadas. Formato: [{"tag": "<tag>", "value": "<value>", "operator": "<operator>"}, ...].Un array vacío devuelve todos los servicios. Valores posibles de operator: 0 - (por defecto) Contiene; 1 - Es igual a; 2 - No contiene; 3 - No es igual a; 4 - Existe; 5 - No existe. |
| problem_tags | object/array | Devolver solo los servicios con las etiquetas de problema dadas. Formato: [{"tag": "<tag>", "value": "<value>", "operator": "<operator>"}, ...].Un array vacío devuelve todos los servicios. Valores posibles de operator: 0 - (por defecto) Contiene; 1 - Es igual a; 2 - No contiene; 3 - No es igual a; 4 - Existe; 5 - No existe. |
| without_problem_tags | flag | Devolver solo los servicios sin etiquetas de problema. |
| slaids | ID/array | Devolver solo los servicios que están vinculados a los SLA(s) específicos. |
| selectChildren | query | Devolver una propiedad children con los servicios hijos.Admite count. |
| selectParents | query | Devolver una propiedad parents con los servicios padre.Admite count. |
| selectTags | query | Devolver una propiedad tags con las etiquetas del servicio.Admite count. |
| selectProblemEvents | query | Devolver una propiedad problem_events con un array de objetos de eventos de problema.El objeto de evento de problema tiene las siguientes propiedades: eventid - (ID) ID del evento;severity - (string) Severidad actual del evento;name - (string) Nombre del evento resuelto.Admite count. |
| selectProblemTags | query | Devolver una propiedad problem_tags con las etiquetas de problema.Admite count. |
| selectStatusRules | query | Devolver una propiedad status_rules con las reglas de estado.Admite count. |
| selectStatusTimeline | object/array | Devolver una propiedad status_timeline que contiene los cambios de estado del servicio para los períodos dados.Formato [{"period_from": "<period_from>", "period_to": "<period_to>"}, ...] - period_from es la fecha de inicio (inclusive; timestamp entero) y period_to es la fecha de finalización (exclusive; timestamp entero) para el período de interés.Devuelve un array de entradas que contiene una propiedad start_value y un array alarms para los cambios de estado dentro de los períodos especificados. |
| sortfield | string/array | Ordenar el resultado por las propiedades dadas. Valores posibles: serviceid, name, status, sortorder, created_at. |
| countOutput | boolean | Estos parámetros se describen en el comentario de referencia. |
| editable | boolean | |
| excludeSearch | boolean | |
| filter | object | |
| 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 todos los servicios
Recupera todos los datos sobre todos los servicios y sus dependencias.
{
"jsonrpc": "2.0",
"method": "service.get",
"params": {
"output": "extend",
"selectChildren": "extend",
"selectParents": ["serviceid", "name"]
},
"id": 1
}Respuesta:
{
"jsonrpc": "2.0",
"result": [
{
"serviceid": "1",
"name": "Zabbix cluster",
"status": "-1",
"algorithm": "2",
"sortorder": "0",
"weight": "0",
"propagation_rule": "0",
"propagation_value": "0",
"description": "",
"uuid": "8d77bd91b62347e4b79382912eb5df95",
"created_at": "1761742392",
"readonly": false,
"parents": [],
"children": [
{
"serviceid": "2",
"name": "Zabbix server node 1",
"status": "-1",
"algorithm": "2",
"sortorder": "0",
"weight": "0",
"propagation_rule": "0",
"propagation_value": "0",
"description": "",
"uuid": "195911d26d7f4e218d6217079bcd5929",
"created_at": "1761742623",
"readonly": false
},
{
"serviceid": "3",
"name": "Zabbix server node 2",
"status": "-1",
"algorithm": "2",
"sortorder": "0",
"weight": "0",
"propagation_rule": "0",
"propagation_value": "0",
"description": "",
"uuid": "9fc659a30fe244f690dff25fc2a9db5c",
"created_at": "1761742654",
"readonly": false
}
]
},
{
"serviceid": "2",
"name": "Zabbix server node 1",
"status": "-1",
"algorithm": "2",
"sortorder": "0",
"weight": "0",
"propagation_rule": "0",
"propagation_value": "0",
"description": "",
"uuid": "195911d26d7f4e218d6217079bcd5929",
"created_at": "1761742623",
"readonly": false,
"parents": [
{
"serviceid": "1",
"name": "Zabbix cluster"
}
],
"children": []
},
{
"serviceid": "3",
"name": "Zabbix server node 2",
"status": "-1",
"algorithm": "2",
"sortorder": "0",
"weight": "0",
"propagation_rule": "0",
"propagation_value": "0",
"description": "",
"uuid": "9fc659a30fe244f690dff25fc2a9db5c",
"created_at": "1761742654",
"readonly": false,
"parents": [
{
"serviceid": "1",
"name": "Zabbix cluster"
}
],
"children": []
}
],
"id": 1
}Fuente
CService::get() en ui/include/classes/api/services/CService.php.