La API de supervisión (alertas del sistema) devuelve las alertas del sistema Evolve (si las hay) que se muestran en la sección Alertas del sistema del panel de administración. Esta API utiliza el método GET para devolver las alertas del sistema.
Cuerpo de solicitud y respuesta
Para devolver las alertas del sistema Evolve (si las hay) mostradas en la sección Alertas del sistema del panel de administración, la estructura de la solicitud y la respuesta será la siguiente:
Contrato de datos de solicitud:
La API de supervisión (alertas del sistema) no necesita ningún cuerpo de solicitud. El usuario tiene que hacer clic en la URL para obtener la lista de notificaciones:
<URL de prefijo>/api/v1/Monitoring/SystemAlerts
Contrato de datos de respuesta:
La respuesta se devolverá en el siguiente formato:
Nombre | Tipo | Descripción |
---|---|---|
CreatedDate | Fecha | Valor de fecha UTC de la fecha de creación de la notificación en formato ISO. |
EnumNotificationScope | Entero | El usuario debe pasar por alto este dato. |
IsMessageLocalized | Bit | El usuario debe pasar por alto este dato. |
Mensaje | Cadena |
Los valores del mensaje son los siguientes:
|
NotificationCategory | Entero | Siempre tiene el valor 1 (alerta del sistema). |
NotificationId | GUID | Valor de GUID único de esta notificación. |
NotificationScope | Entero |
Valor según el ámbito de la notificación. 0 - Global. 1- Aplicación. |
NotificationState | Entero | El usuario debe pasar por alto este dato. |
NotificationType | Entero | Tiene el valor 2 siempre (es decir, Advertencia del sistema). |
TeamspaceId | GUID | Valor de GUID de aplicación (si la notificación es para una aplicación específica, es decir, cuando NotificationScope es 1; de lo contrario, se devuelve un GUID vacío). |
UserId | GUID | Valor de GUID del usuario si la alerta es específica de un usuario de Evolve; de lo contrario, se devuelve un GUID vacío. |
messageParameters | JSON | Valor de JSON con más detalles sobre el mensaje. |
Ejemplo de solicitud y respuesta:
El siguiente ejemplo muestra el uso de la API:
Respuesta
{ "NotificationId": "4378ec0b-5365-4535-ab32-e104dd92f080", "NotificationType": 2, "Message": "Machine_Down", "NotificationCategory": 1, "UserId": "00000000-0000-0000-0000-000000000000", "EnumNotificationScope": 0, "TeamspaceId": "00000000-0000-0000-0000-000000000000", "CreatedDate": "2021-06-20T10:56:23.803", "NotificationScope": 0, "NotificationState": 0, "IsMessageLocalized": false, "messageParameters": "[{\"id\":0,\"ParameterValue\":\"CHA-EN-VST679\"}]" }, { "NotificationId": "c6ae12c0-4e5c-4a1a-938b-fe120693932e", "NotificationType": 2, "Message": "Queue_Error", "NotificationCategory": 1, "UserId": "00000000-0000-0000-0000-000000000000", "EnumNotificationScope": 0, "TeamspaceId": "00000000-0000-0000-0000-000000000000", "CreatedDate": "2021-07-12T10:37:12.273", "NotificationScope": 0, "NotificationState": 0, "IsMessageLocalized": false, "messageParameters": "[{\"id\":0,\"ParameterValue\":\"Host : CHA-EN-VST679 Queue : AutoRunFile\"}]" }, { "NotificationId": "938f852d-e113-487e-aad3-87f45d28dc68", "NotificationType": 2, "Message": "Queue_Error", "NotificationCategory": 1, "UserId": "00000000-0000-0000-0000-000000000000", "EnumNotificationScope": 0, "TeamspaceId": "00000000-0000-0000-0000-000000000000", "CreatedDate": "2021-07-12T10:56:45.313", "NotificationScope": 0, "NotificationState": 0, "IsMessageLocalized": false, "messageParameters": "[{\"id\":0,\"ParameterValue\":\"Host : CHA-PLP41326 Queue : Reporting\"}]" }...