Sidebar

Zabbix Summit 2022
Register for Zabbix Summit 2022

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. Consulte Funções de usuário para obter 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 string/array Retornar apenas as manutenções atribuídas aos grupos de hosts fornecidos.
hostids string/array Retornar apenas as manutenções atribuídas aos hosts fornecidos.
maintenanceids string/array Devolva apenas manutenções com os IDs fornecidos.
selectGroups query Retorne uma propriedade groups com grupos de hosts atribuídos à manutenção.
selectHosts query Retorne uma propriedade hosts com hosts atribuídos à manutenção.
selectTags query Retorna uma propriedade tags com tags de problema da manutenção.
selectTimeperiods query Retorna uma propriedade tags com tags de problema da manutenção.
sortfield string/array Classifique o resultado pelas propriedades fornecidas.

Os valores possíveis são: maintenanceid, name e maintenance_type.
countOutput boolean Esses parâmetros sendo comuns para todos os métodos get são descritos em detalhes em 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 ou:

  • uma série de objetos;
  • a contagem de objetos recuperados, se o parâmetro countOutput tiver sido usado.

Exemplos

Recuperando manutenção

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.

Request:

{
           "jsonrpc": "2.0",
           "method": "maintenance.get",
           "params": {
               "output": "extend",
               "selectGroups": "extend",
               "selectTimeperiods": "extend",
               "selectTags": "extend"
           },
           "auth": "038e1d7b1735c6a5436ee9eae095879e",
           "id": 1
       }

Response:

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

Veja também

Fonte

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