maintenance.get

Descripción

integer/array maintenance.get(object parameters)

El método permite recuperar mantenimientos 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 del rol 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
groupids	ID/array	Devolver solo mantenimientos que estén asignados a los grupos de equipos dados.
hostids	ID/array	Devolver solo mantenimientos que estén asignados a los equipos dados.
maintenanceids	ID/array	Devolver solo mantenimientos con los IDs dados.
selectHostGroups	query	Devolver una propiedad `hostgroups` con los grupos de equipos asignados al mantenimiento.
selectHosts	query	Devolver una propiedad `hosts` con los equipos asignados al mantenimiento.
selectTags	query	Devolver una propiedad `tags` con las etiquetas de problema del mantenimiento.
selectTimeperiods	query	Devolver una propiedad `timeperiods` con los periodos de tiempo del mantenimiento.
sortfield	string/array	Ordenar el resultado por las propiedades dadas. Valores posibles: `maintenanceid`, `name`, `maintenance_type`.
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 mantenimientos

Recupera todos los mantenimientos configurados y los datos sobre los grupos de equipos asignados, los periodos de tiempo definidos y las etiquetas de problemas.

Solicitud:

{
           "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
       }

Véase también

Fuente

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

Documentation