Documentation
Table of Contents
mantenimiento.obtener
Descripción
integer/array maintenance.get(object parameters)
El método permite recuperar mantenimientos de acuerdo con los parámetros dados.
Este método está disponible para usuarios de cualquier tipo. Los permisos para activar el método se pueden revocar en la configuración de roles de usuario. Ver User roles 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 |
|---|---|---|
| groupids | cadena/matriz | Devuelve sólo los mantenimientos que están asignados a los grupos de hosts dados. |
| hostids | cadena/matriz | Devuelve sólo los mantenimientos que están asignados a los hosts dados. |
| maintenanceids | cadena/matriz | Devuelve solo mantenimientos con los ID proporcionados. |
| selectGroups | conaulta | Devuelve una propiedad groups con grupos de hosts asignados al mantenimiento. |
| selectHosts | consulta | Devuelve una propiedad hosts con hosts asignados al mantenimiento. |
| selectTags | consulta | Devuelve una propiedad tags con etiquetas problemáticas del mantenimiento. |
| selectTimeperiods | consulta | Devuelve una propiedad timeperiods con los períodos de tiempo del mantenimiento. |
| sortfield | cadena/matriz | Ordena el resultado por las propiedades dadas. Los valores posibles son: maintenanceid, name y maintenance_type. |
| countOutput | booleano | Estos parámetros, que son comunes para todos los métodos get, se describen en detalle en el reference commentary. |
| editable | booleano | |
| excluirBuscar | booleano | |
| filtro | objeto | |
| límite | númeroentero | |
| salida | consulta | |
| preservekeys | booleano | |
| buscar | objeto | |
| searchByAny | booleano | |
| searchWildcardsEnabled | booleano | |
| clasificación | cadena/matriz | |
| iniciarBuscar | booleano |
Valores de retorno
(integer/array) Devuelve:
- una matriz de objetos;
- el recuento de objetos recuperados, si el parámetro
countOutputha sido usado.
Ejemplos
Recuperar mantenimientos
Recuperar todos los mantenimientos configurados y los datos sobre los grupos asignados de hosts, períodos de tiempo definidos y etiquetas de problemas.
Solicitud:
{
"jsonrpc": "2.0",
"method": "maintenance.get",
"params": {
"output": "extend",
"selectGroups": "extend",
"selectTimeperiods": "extend",
"selectTags": "extend"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}Respuesta:
{
"jsonrpc": "2.0",
"result": [
{
"maintenanceid": "3",
"name": "Sunday maintenance",
"maintenance_type": "0",
"description": "",
"active_since": "1358844540",
"active_till": "1390466940",
"tags_evaltype": "0",
"groups": [
{
"groupid": "4",
"name": "Zabbix servers",
"internal": "0"
}
],
"timeperiods": [
{
"timeperiod_type": "3",
"every": "1",
"month": "0",
"dayofweek": "1",
"day": "0",
"start_time": "64800",
"period": "3600",
"start_date": "2147483647"
}
],
"tags": [
{
"tag": "service",
"operator": "0",
"value": "mysqld",
},
{
"tag": "error",
"operator": "2",
"value": ""
}
]
}
],
"id": 1
}Ver también
-Host -Host group -Time period
Fuente
CMaintenance::get() enui/include/classes/api/services/CMaintenance.php.