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 de 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 aceita os seguintes parâmetros.

Parâmetro Tipo Descrição
groupids ID/array Retorna apenas as manutenções atribuídas aos grupos de hosts especificados.
hostids ID/array Retorna apenas as manutenções atribuídas aos hosts especificados.
triggerids ID/array Retorna apenas as manutenções atribuídas aos triggers especificados.
maintenanceids ID/array Retorna apenas as manutenções com os IDs especificados.
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.
selectTriggers query Retorna uma propriedade triggers com os triggers atribuídos à manutenção.
selectEventNames query Retorna uma propriedade event_names com os nomes de eventos 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 especificadas.

Valores possíveis: maintenanceid, name, maintenance_type, active_since, active_till.
countOutput boolean Esses parâmetros estã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 tiver sido usado.

Exemplos

Recuperando manutenções

Recupere todas as manutenções configuradas, os dados sobre o escopo de manutenção atribuído (grupo de hosts, host, trigger, nome do evento, tags) e os períodos definidos.

Solicitação:

{
    "jsonrpc": "2.0",
    "method": "maintenance.get",
    "params": {
        "output": "extend",
        "selectHostGroups": "extend",
        "selectHosts": "extend",
        "selectTriggers": "extend",
        "selectEventNames": "extend",
        "selectTags": "extend",
        "selectTimeperiods": "extend"
    },
    "id": 1
}

Resposta:


{
  "jsonrpc": "2.0",
  "result": [
    {
      "maintenanceid": "1",
      "name": "Manutenção regular do banco de dados",
      "maintenance_type": "0",
      "description": "",
      "active_since": "1791936000",
      "active_till": "2107555200",
      "tags_evaltype": "0",
      "hostgroups": [
        {
          "groupid": "20",
          "name": "Bancos de dados",
          "flags": "0",
          "uuid": "748ad4d098d447d492bb935c907f652f"
        }
      ],
      "triggers": [],
      "event_names": [],
      "hosts": [],
      "tags": [],
      "timeperiods": [
        {
          "timeperiod_type": "4",
          "every": "1",
          "month": "4095",
          "dayofweek": "0",
          "day": "1",
          "start_time": "64800",
          "period": "3600",
          "start_date": "0"
        }
      ]
    },
    {
      "maintenanceid": "2",
      "name": "Ad hoc: Impressora: tinta ESGOTADA",
      "maintenance_type": "0",
      "description": "",
      "active_since": "1792057740",
      "active_till": "1792061340",
      "tags_evaltype": "0",
      "hostgroups": [
        {
          "groupid": "4",
          "name": "Servidores Zabbix",
          "flags": "0",
          "uuid": "6f6799aa69e844b4b3918f779f2abf08"
        }
      ],
      "triggers": [],
      "event_names": [
        {
          "operator": "2",
          "value": "Impressora: tinta ESGOTADA"
        }
      ],
      "hosts": [],
      "tags": [],
      "timeperiods": [
        {
          "timeperiod_type": "0",
          "every": "1",
          "month": "0",
          "dayofweek": "0",
          "day": "0",
          "start_time": "0",
          "period": "3600",
          "start_date": "1792057740"
        }
      ]
    }
  ],
  "id": 1
}```

[comment]: # ({/ec7146e4-0b1cb387})

[comment]: # ({0c4dce96-dbcf678a})
### Veja também

-   [Host](/manual/api/reference/host/object#host)
-   [Grupo de hosts](/manual/api/reference/hostgroup/object#host-group)
-   [Trigger](/manual/api/reference/trigger/object#trigger)
-   [Nome do evento](object#event-name)
-   [Tag do problema](object#problem-tag)
-   [Período de tempo](object#time-period)

[comment]: # ({/0c4dce96-dbcf678a})

[comment]: # ({f0ec3c40-50ed5be3})
### Fonte

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

[comment]: # ({/f0ec3c40-50ed5be3})