Documentation
Table of Contents
maintenance.get
Descripció
integer/array maintenance.get(object parameters)
El mètode permet recuperar manteniments segons els paràmetres proveïts.
Aquest mètode és disponible per a usuaris de qualsevol mena. Els permisos per cridar al mètode es poden revocar a les configuracions de rols d'usuari. Per a més informació, veieu Rols d'usuari.
Paràmetres
(object) Paràmetre definint la sortida esperada.
El mètode admet els següents paràmetres.
| Paràmetre | Tipus | Descripció |
|---|---|---|
| groupids | ID/array | Retorna només els manteniments assignats als grups d'equips donats. |
| hostids | ID/array | Retorna només els manteniments assignats als equips donats. |
| maintenanceids | ID/array | Retorna només manteniments amb els identificadors donats. |
| selectHostGroups | query | Retorna una propietat hostgrups que conté els grups d'equips assignats al manteniment. |
| selectHosts | query | Retorna una propietat hosts que conté els equips assignats per al manteniment. |
| selectTags | query | Retorna una propietat tags que conté les etiquetes del problema de manteniment. |
| selectTimeperiods | query | Retorna una propietat timeperiods que conté els períodes de manteniment. |
| sortfield | string/array | Ordena el resultat per les propietats donades. Els valors possibles són: maintenance, name i maintenance_type. |
| countOutput | boolean | Aquests paràmetres es descriuen als comentaris de referència. |
| editable | boolean | |
| excludeSearch | boolean | |
| filter | object | |
| limit | integer | |
| output | query | |
| preservekeys | boolean | |
| search | object | |
| searchByAny | boolean | |
| searchWildcardsEnabled | boolean | |
| sortorder | string/array | |
| startSearch | boolean | |
| selectGroups (obsolet) |
query | Aquest paràmetre és obsolet; si et plau, empra selectHostGroups en el seu lloc.Retorna la propietat grups amb informació dels grups d'equips on pertany l'equip. |
Valors de retorn
(integer/array) Retorna un d'entre:
- una taula d'objectes;
- el recompte d'objectes recuperats, si s'empra el paràmetre
countOutput.
Exemples
Recuperar manteniments
Recuperar tots els manteniments configurats, les dades dels grups d'equips afectats, els períodes definits i els tags de problemes.
{
"jsonrpc": "2.0",
"method": "maintenance.get",
"params": {
"output": "extend",
"selectHostGroups": "extend",
"selectTimeperiods": "extend",
"selectTags": "extend"
},
"id": 1
}Resposta:
{
"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
}Veieu també
Font
CMaintenance::get() in ui/include/classes/api/services/CMaintenance.php.