Documentation
Table of Contents
maintenance.get
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 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 |
|---|---|---|
| groupids | cadena/matriz | Devuelve sólo los mantenimientos que están asignados a los grupos de equipos dados. |
| hostids | cadena/matriz | Devuelve sólo los mantenimientos que están asignados a los equipos dados. |
| maintenanceids | cadena/matriz | Devuelve solo mantenimientos con los ID proporcionados. |
| selectHostGroups | query | Devuelve una propiedad hostgroups con grupos de equipos asignados al mantenimiento. |
| selectHosts | consulta | Devuelve una propiedad hosts con equipos asignados al mantenimiento. |
| selectTags | query | Devuelve una propiedad tags con etiquetas problemáticas del mantenimiento. |
| selectTimeperiods | query | Devuelve una propiedad timeperiods con los períodos de tiempo del mantenimiento. |
| sortfield | cadena/matriz | Ordena el resultado por las propiedades dadas. Valores posibles: maintenanceid, name, maintenance_type. |
| countOutput | booleano | 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 | |
| selectGroups (obsoleto) |
query | Este parámetro está obsoleto; utilice selectHostGroups en su lugar.Devuelve una propiedad groups con grupos de equipos asignados al mantenimiento. |
Valores de retorno
(entero/matriz) Devuelve:
- una matriz de objetos;
- el recuento de objetos recuperados, si el parámetro
countOutputha sido usado.
Ejemplos
Recuperando mantenimientos
Recuperar todos los mantenimientos configurados y los datos sobre los grupos de equipos asignados, períodos de tiempo definidos y etiquetas de problemas.
{
"jsonrpc": "2.0",
"method": "maintenance.get",
"params": {
"output": "extend",
"selectHostGroups": "extend",
"selectTimeperiods": "extend",
"selectTags": "extend"
},
"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",
"hostgroups": [
{
"groupid": "4",
"name": "Zabbix servers",
"flags": "0",
"uuid": "6f6799aa69e844b4b3918f779f2abf08"
}
],
"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
Fuente
CMaintenance::get() enui/include/classes/api/services/CMaintenance.php.