event.acknowledge

Descrição

object event.acknowledge(object/array parameters)

Este método permite atualizar eventos. As seguintes ações de atualização podem ser executadas:

  • Fechar evento. Se o evento já estiver resolvido, esta ação será ignorada.
  • Reconhecer evento. Se o evento já estiver reconhecido, esta ação será ignorada.
  • Desreconhecer evento. Se o evento não estiver reconhecido, esta ação será ignorada.
  • Adicionar mensagem.
  • Alterar a severidade do evento. Se o evento já tiver a mesma severidade, esta ação será ignorada.
  • Suprimir evento. Se o evento já estiver suprimido, esta ação será ignorada.
  • Dessuprimir evento. Se o evento não estiver suprimido, esta ação será ignorada.
  • Alterar a classificação do evento para causa. Se o evento já estiver classificado como causa, esta ação será ignorada.
  • Alterar a classificação do evento para sintoma. Se o evento já estiver classificado como sintoma, esta ação será ignorada.

Somente eventos de trigger podem ser atualizados.
Somente eventos de problema podem ser atualizados.
São necessárias permissões de leitura/gravação para o trigger para fechar o evento ou alterar a severidade do evento.
Para fechar um evento, o fechamento manual deve ser permitido no trigger.

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/array) Parâmetros contendo os IDs dos eventos e das operações de atualização que devem ser executadas.

Parameter Type Description
eventids ID/array IDs dos events a serem reconhecidos.

Comportamento do parâmetro:
- required
action integer Ação(ões) de atualização do event.

Valores possíveis de bitmap:
1 - fechar problema;
2 - reconhecer event;
4 - adicionar mensagem;
8 - alterar severidade;
16 - cancelar reconhecimento do event;
32 - suprimir event;
64 - remover supressão do event;
128 - alterar a classificação do event para causa;
256 - alterar a classificação do event para sintoma.

Este é um campo de bitmask; qualquer soma dos valores possíveis de bitmap é स्वीकारável (por exemplo, 34 para reconhecer e suprimir o event).

Comportamento do parâmetro:
- required
cause_eventid ID ID do event de causa.

Comportamento do parâmetro:
- required se action contiver o bit "alterar a classificação do event para sintoma"
message string Texto da mensagem.

Comportamento do parâmetro:
- required se action contiver o bit "adicionar mensagem"
severity integer Nova severidade para os events.

Valores possíveis:
0 - não classificado;
1 - informação;
2 - aviso;
3 - médio;
4 - alto;
5 - desastre.

Comportamento do parâmetro:
- required se action contiver o bit "alterar severidade"
suppress_until integer Timestamp Unix até o qual o event deve ser suprimido.

Se definido como "0", a supressão será indefinida.

Comportamento do parâmetro:
- required se action contiver o bit "suprimir event"

Valores de retorno

(object) Retorna um objeto contendo os IDs dos eventos atualizados na propriedade eventids.

Exemplos

Reconhecendo um evento

Reconheça um único evento e deixe uma mensagem.

Requisição:

{
    "jsonrpc": "2.0",
    "method": "event.acknowledge",
    "params": {
        "eventids": "20427",
        "action": 6,
        "message": "Problem resolved."
    },
    "id": 1
}

Resposta:

{
    "jsonrpc": "2.0",
    "result": {
        "eventids": [
            "20427"
        ]
    },
    "id": 1
}

Alterando a gravidade do evento

Altere a gravidade de vários eventos e deixe uma mensagem.

Requisição:

{
    "jsonrpc": "2.0",
    "method": "event.acknowledge",
    "params": {
        "eventids": ["20427", "20428"],
        "action": 12,
        "message": "Maintenance required to fix it.",
        "severity": 4
    },
    "id": 1
}

Resposta:

{
    "jsonrpc": "2.0",
    "result": {
        "eventids": [
            "20427",
            "20428"
        ]
    },
    "id": 1
}

Suprimindo um evento indefinidamente

Suprima um único evento sem um tempo de expiração.

Request:

{
    "jsonrpc": "2.0",
    "method": "event.acknowledge",
    "params": {
        "eventids": "20427",
        "action": 32,
        "suppress_until": 0
    },
    "id": 1
}

Response:

{
    "jsonrpc": "2.0",
    "result": {
        "eventids": [
            20427
        ]
    },
    "id": 1
}

Dessuprimir um evento

Dessuprima um único evento previamente suprimido.

Request:

{
    "jsonrpc": "2.0",
    "method": "event.acknowledge",
    "params": {
        "eventids": "20427",
        "action": 64
    },
    "id": 1
}

Response:

{
    "jsonrpc": "2.0",
    "result": {
        "eventids": [
            20427
        ]
    },
    "id": 1
}

Reconhecer e suprimir um evento

Reconheça um ou mais eventos, adicione uma mensagem e suprima-os na mesma solicitação.

Request:

{
    "jsonrpc": "2.0",
    "method": "event.acknowledge",
    "params": {
        "eventids": [
            "20427",
            "20428"
        ],
        "action": 38,
        "message": "Suppressing during planned maintenance.",
        "suppress_until": 0
    },
    "id": 1
}

Resposta:

{
    "jsonrpc": "2.0",
    "result": {
        "eventids": [
            20427,
            20428
        ]
    },
    "id": 1
}

Fonte

CEvent::acknowledge() em ui/include/classes/api/services/CEvent.php.