maintenance.get

Descrição

integer/array maintenance.get(object parameters)

O método permite recuperar manutenções de acordo com os parâmetros fornecidos.

Este método está disponível para usuários de qualquer tipo. As permissões para chamar o método podem ser revogadas nas configurações de função do usuário. Veja Funções de usuário para mais informações.

Parâmetros

(object) Parâmetros que definem a saída desejada.

O método suporta os seguintes parâmetros.

Parâmetro	Tipo	Descrição
groupids	ID/array	Retorna apenas manutenções atribuídas aos grupos de hosts fornecidos.
hostids	ID/array	Retorna apenas manutenções atribuídas aos hosts fornecidos.
maintenanceids	ID/array	Retorna apenas manutenções com os IDs fornecidos.
selectHostGroups	query	Retorna uma propriedade `hostgroups` com os grupos de hosts atribuídos à manutenção.
selectHosts	query	Retorna uma propriedade `hosts` com os hosts atribuídos à manutenção.
selectTags	query	Retorna uma propriedade `tags` com as tags de problema da manutenção.
selectTimeperiods	query	Retorna uma propriedade `timeperiods` com os períodos de tempo da manutenção.
sortfield	string/array	Ordena o resultado pelas propriedades fornecidas. Valores possíveis: `maintenanceid`, `name`, `maintenance_type`.
countOutput	boolean	Esses parâmetros são descritos no comentário 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

Valores de retorno

(integer/array) Retorna:

um array de objetos;
a contagem de objetos recuperados, se o parâmetro countOutput foi utilizado.

Exemplos

Recuperando manutenções

Recupere todas as manutenções configuradas e os dados sobre os grupos de hosts atribuídos, períodos de tempo definidos e tags de problemas.

Requisição:

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

Veja também

Fonte

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

Documentation