event.acknowledge

Descripción

object event.acknowledge(object/array parameters)

Este método permite actualizar eventos. Se pueden realizar las siguientes acciones de actualización:

  • Cerrar evento. Si el evento ya está resuelto, esta acción se omitirá.
  • Reconocer evento. Si el evento ya está reconocido, esta acción se omitirá.
  • Anular reconocimiento del evento. Si el evento no está reconocido, esta acción se omitirá.
  • Agregar mensaje.
  • Cambiar la severidad del evento. Si el evento ya tiene la misma severidad, esta acción se omitirá.
  • Suprimir evento. Si el evento ya está suprimido, esta acción se omitirá.
  • Anular supresión del evento. Si el evento no está suprimido, esta acción se omitirá.
  • Cambiar la clasificación del evento a causa. Si el evento ya está clasificado como causa, esta acción se omitirá.
  • Cambiar la clasificación del evento a síntoma. Si el evento ya está clasificado como síntoma, esta acción se omitirá.

Solo se pueden actualizar eventos de trigger.
Solo se pueden actualizar eventos de problema.
Se requieren permisos de lectura/escritura para el trigger para cerrar el evento o cambiar la severidad del evento.
Para cerrar un evento, el cierre manual debe estar permitido en el trigger.

Este método está disponible para usuarios de cualquier tipo. Los permisos para llamar al método pueden revocarse en la configuración del rol de usuario. Consulte User roles para obtener más información.

Parámetros

(object/array) Parámetros que contienen los ID de los eventos y las operaciones de actualización que deben realizarse.

Parameter Type Description
eventids ID/array ID de los eventos que se deben reconocer.

Comportamiento del parámetro:
- obligatorio
action integer Acción o acciones de actualización del evento.

Valores de bitmap posibles:
1 - cerrar el problema;
2 - reconocer el evento;
4 - añadir un mensaje;
8 - cambiar la gravedad;
16 - dejar de reconocer el evento;
32 - suprimir el evento;
64 - dejar de suprimir el evento;
128 - cambiar la clasificación del evento a causa;
256 - cambiar la clasificación del evento a síntoma.

Este es un campo de máscara de bits; se acepta cualquier suma de los valores de bitmap posibles (por ejemplo, 6 para reconocer un evento y dejar un mensaje, o 34 para reconocer y suprimir un evento).

Comportamiento del parámetro:
- obligatorio
cause_eventid ID ID del evento causante.

Comportamiento del parámetro:
- obligatorio si action contiene el bit «cambiar la clasificación del evento a síntoma»
message string Texto del mensaje.

Comportamiento del parámetro:
- obligatorio si action contiene el bit «añadir un mensaje»
severity integer Nueva gravedad de los eventos.

Valores posibles:
0 - no clasificado;
1 - información;
2 - advertencia;
3 - promedio;
4 - alto;
5 - desastre.

Comportamiento del parámetro:
- obligatorio si action contiene el bit «cambiar la gravedad»
suppress_until integer Marca de tiempo de Unix hasta la cual se debe suprimir el evento.

Si se establece en «0», la supresión será indefinida.

Comportamiento del parámetro:
- obligatorio si action contiene el bit «suprimir el evento»

Valores de retorno

(object) Devuelve un objeto que contiene los IDs de los eventos actualizados en la propiedad eventids.

Ejemplos

Reconociendo un evento

Reconocer un solo evento y dejar un mensaje.

Solicitud:

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

Respuesta:

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

Cambiar la gravedad del evento

Cambiar la gravedad de varios eventos y dejar un mensaje.

Solicitud:

{
    "jsonrpc": "2.0",
    "method": "event.acknowledge",
    "params": {
        "eventids": ["20427", "20428"],
        "action": 12,
        "message": "Se requiere mantenimiento para solucionarlo.",
        "severity": 4
    },
    "id": 1
}

Respuesta:

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

Suprimir un evento indefinidamente

Suprime un único evento sin tiempo de expiración.

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
}

Anular la supresión de un evento

Anule la supresión de un único evento previamente suprimido.

Solicitud:

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

Respuesta:

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

Reconocer y suprimir un evento

Reconozca uno o más eventos, agregue un mensaje y suprímalos en la misma solicitud.

Solicitud:

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

Respuesta:

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

Fuente

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