Alarms

Descripción

Este endpoint muestra un registro de alarmas generadas por mqtt que se envían al servidor de Netin.

Este registro se debe consultar en el caso de que se quiera conocer aquellas alarmas activas para solucionar cualquier problema relacionado con ellas en la instalación.

Podemos encontrarlo en la ruta <ip>:<mqtt_port>/v1/alarms.

Visualización

Al realizarle una petición GET al endpoint nos devuelve una respuesta en formato JSON.

{
    "size": {
        "total": 0,
        "active": 0,
        "inactive": 0
    },
    "lastUpdate": "",
    "active": [],
    "inactive": []
}        

Listado de campos

• size(object): Consta de 3 campos total, active e inactive.

• total(number): Indica el número total de posibles alarmas configuradas.

• active(number): Indica el número total de alarmas activas en el momento de la consulta.

• inactive(number): Indica el número total de alarmas que no se encuentran activadas en el momento de la consulta.

• lastUpdate(string): Indica la fecha de la última actualización en la configuración de las alarmas.

• active(IAlarm[]): Muestra el conjunto de alarmas activadas en el momento de la consulta.

• inactive(IAlarm[]): Muestra el conjunto de alarmas inactivas en el momento de la consulta.

Cada alarma cuenta con los siguientes campos:

• schemaVersion(string): Indica la versión de la plantillade Netin por la cual se muestra la alarma.

• id(string): Indica un identificador único para la alarma.

• deviceId(string): Indica el identificador del dispositivo en el cual se ha producido la alarma.

• entity(string): Indica el identificador de la entidad donde se ha producido la alarma.

• entityType(string): Indica el tipo de entidad donde se ha producido la alarma. Puede tener los siguientes valores:

    'netin-ds-agent',
    'netin-ds-server',
    'netin-ds-webui',
    'netin-hub-agent',
    'netin-hub-device',
    'netin-hub-server',
    'netin-hub-webui'
  

• originType(string): Indica el tipo de driver que ha originado la alarma.

• facility(number): Indica el grupo de recursos al que pertenece la alarma.

• [OBSOLETO] location(Array): Indica la localización del origen de la alarma. Usar solo en versiones antiguas de Netin, en sistemas nuevos usad la propiedad locationId.

• locationId(string): Localización jerárquica donde se muestra la fuente del origen de la alarma.

• gone(boolean): Indica si la alarma se ha ido.

• cot(string): Motivo por el cual el evento de transmisión de la alarma ha ocurrido. Puede tener uno de los siguientes valores 'came', 'went', 'qualityChange', 'severityChange', 'period'. Por defecto es 'came'.

• auditState(number): Estado del proceso de consultoría para la alarma. A continuación se presenta una lista de los posibles valores junto a sus significados:

no consultada = -1, recibida = 0, comenzada = 1, mantenida = 2, completada = 3, transferida = 4

• audited(boolean): Indica si la alarma debe ser consultada por el usuario.

• hidden(boolean): Indica si la alarma está oculta.

• broadcast(boolean): Indica si la alarma debe ser enviada a servicios externos a Netin.

• text(string): Texto descriptivo sobre el evento lanzado.

• textHelp(string): Información detallada sobre el evento o sobre cómo resolverlo.

• tsCame(number): Fecha (en formato epoch, milisegundos) en el que se produjo el evento de activación de alarma.

• tsWent(number): Fecha (en formato epoch, milisegundos) en el que se produjo el evento de desactivación de alarma.

• templateId(string): Identificación de la plantilla en la cual se ha configurado la alarma

• routing(Object): En el caso de que se cumpla broadcast=true indica las características del servicio al que se dirige la alarma.

Cuenta con las siguientes propiedades:

- **topic(string):** Indica el topic de Kafka al que se inserta la alarma.

-   **service(string):** Indica el servicio de AWS al que se dirige la alarma.

-   **serviceConfig(object):** Es un objeto que puede contener diferentes campos para indicar donde se debería enrutar la alarma dentro del servicio. Por ahora, e ha configurado la propiedad `bucketName` para indicar el nombre del bucket en el servicio de AWS S3.