Recibir alertas activas
Recupere alertas específicas del sistema que coincidan con los criterios que usted proporcione.
Requisitos previos
Autenticar - Envíe sus credenciales de usuario, ID de cliente y secreto de cliente para la autenticación OAuth2. Consulte API Authentication para obtener instrucciones sobre cómo llamar a la API OAuth para validar y autenticar sus credenciales.
Búsqueda de alertas del sistema
Para buscar alertas del sistema que coincidan con los criterios de búsqueda proporcionados, envíe una solicitud POST al punto final /smartview/v2/systemAlerts/search. Especifique los criterios de búsqueda en el cuerpo de la solicitud.
Ejemplo de solicitud cURL - recuperar alertas activas del sistema:
curl -X POST 'https://api.equinix.com/smartview/v2/systemAlerts/search'
-H 'content-type: application/json'
-H 'authorization: Bearer <token>'
-d '{
"filter": {
"and": [
{
"property": "/status",
"operator": "=",
"values": [
"ACTIVE"
]
}
]
},
"pagination": {
"offset": 0,
"limit": 50
}
}'
Respuesta de muestra:
{
"data": [
{
"id": 1931,
"alertUid": "LD9.Generator-DH09-PG2:gensetavailableinauto#DIGITAL:ALARM",
"traceUid": "1687495706640/LD9.Generator-DH09-PG2:gensetavailableinauto#DIGITAL:ALARM",
"assetTagUid": "LD9.Generator-DH09-PG2:gensetavailableinauto",
"assetTagDisplayName": "Genset Available In Auto",
"status": "ACTIVE",
"value": {
"alertTagValue": "true",
"alertTagValueDisplayName": "OPEN",
"activeAlertTagValueDisplayName": "OPEN",
"currentTagValue": "CLOSED"
},
"asset": {
"ibx": "LD9",
"assetUid": "LD9.Generator-DH09-PG2",
"assetType": "Generator",
"assetClassification": "Electrical",
"assetRegion": null,
"assetUnderMaintenance": false
},
"configuration": {
"thresholdValue": "1",
"thresholdValueDisplayName": "OPEN",
"unitOfMeasurement": "&",
"thresholdType": "DIGITAL",
"conditionName": "ALARM",
"configurationVersion": "1.0"
},
"activeProcessing": {
"edgeCollectedOn": "2023-06-23T04:48:26.640Z",
"tagCalculationJobProcessedOn": "2023-06-23T04:48:26.840Z",
"processingStartOn": "2023-06-23T04:49:01.182223Z",
"processingEndOn": "2023-06-23T04:49:01.282301Z",
"publishedOn": "2023-06-23T04:49:01.282301Z"
},
"inactiveProcessing": {
"edgeCollectedOn": null,
"tagCalculationJobProcessedOn": null,
"processingStartOn": null,
"processingEndOn": null,
"publishedOn": null
}
},
{
"id": 9684,
"alertUid": "LD4.UPS-4-2-G-15:lowbatteryalarm#DIGITAL:ALARM",
"traceUid": "1687474008537/LD4.UPS-4-2-G-15:lowbatteryalarm#DIGITAL:ALARM",
"assetTagUid": "LD4.UPS-4-2-G-15:lowbatteryalarm",
"assetTagDisplayName": "Low Battery Alarm",
"status": "ACTIVE",
"value": {
"alertTagValue": "true",
"alertTagValueDisplayName": "OPEN",
"activeAlertTagValueDisplayName": "OPEN",
"currentTagValue": "OPEN"
},
"asset": {
"ibx": "LD4",
"assetUid": "LD4.UPS-4-2-G-15",
"assetType": "UPS",
"assetClassification": "Electrical",
"assetRegion": null,
"assetUnderMaintenance": false
},
"configuration": {
"thresholdValue": "1",
"thresholdValueDisplayName": "OPEN",
"unitOfMeasurement": "&",
"thresholdType": "DIGITAL",
"conditionName": "ALARM",
"configurationVersion": "1.0"
},
"activeProcessing": {
"edgeCollectedOn": "2023-06-22T22:46:48.537Z",
"tagCalculationJobProcessedOn": "2023-06-22T22:46:48.737Z",
"processingStartOn": "2023-06-22T22:47:37.722099Z",
"processingEndOn": "2023-06-22T22:47:37.802681Z",
"publishedOn": "2023-06-22T22:47:37.802681Z"
},
"inactiveProcessing": {
"edgeCollectedOn": null,
"tagCalculationJobProcessedOn": null,
"processingStartOn": null,
"processingEndOn": null,
"publishedOn": null
}
}
],
"pagination": {
"offset": 20,
"limit": 10,
"total": 2
}
}
Obtención de todas las alertas del sistema
Para obtener todas las alertas del sistema, envíe una solicitud GET al punto final /smartview/v2/systemAlerts/search. Los criterios de paginación y filtrado están disponibles como parámetros de consulta.