Alarms to System Alerts - Parameters Mapping

Alarms to System Alerts Migration

Overview

/alarms request	/systemAlerts request	Description
GET /alarms/v1/smartview/alarms	POST /smartview/v2/systemAlerts/search	Request: Get Alarms is a simple GET request that supports a very limited number of input parameters, passed in the query. Retrieve System Alerts is a POST request with input parameters passed in the payload. It supports a larger number of parameters, enabling retrieval of much finer datasets. Response: Alarms data model structure is flat and provides limited information on active alarms only. System Alerts data model provides a more detailed insight into alerts and their processing.

Sample curl request

/alarms

curl -X 
GET 'https://api.equinix.com/alarm/v1/smartview/alarms?accountNo=1&limit=10'
-H 'authorization: Bearer asxQMSbBwcNzI2fCCNwSwTh3phV2'

/systemAlerts

curl -X POST 'http://api.equinix.com/smartview/v2/systemAlerts/search'
-H 'content-type: application/json'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'
-d '{
    "filter": {
        "and": [
            {
                "property": "/status",
                "operator": "=",
                "values": [
                    "ACTIVE"
                ]
            }
        ]
    },
    "pagination": {
        "offset": 0,
        "limit": 10
    }
}'

Input parameters

Get Alarms API request supports a limited number of parameters passed in query. Retrieve System Alerts features a number of input parameters passed in the payload.

/alarms request	/systemAlerts request	Example	Description
accountNo `string` REQUIRED	-	/alarms: 1	Customer account identifier.
groupByIBX `boolean` OPTIONAL	-	/alarms: true	Group alarms by IBX data center.
offset `integer` OPTIONAL	pagination.offset `integer` OPTIONAL	10	Index of the first item returned in the response.
limit `integer` OPTIONAL	pagination.limit `integer` OPTIONAL	10	Maximum number of items returned per page.
-	status `string` OPTIONAL	/systemAlerts: ACTIVE	System alert status.
-	assetTagUid `string` OPTIONAL	/systemAlerts: PA8A.CB-CRITICAL-DB2:tripped	Asset tag point identifier.
-	assetTagDisplayName `string` OPTIONAL	/systemAlerts: ALARM	Active tag display name.
-	configuration.thresholdType `string` OPTIONAL	/systemAlerts: DIGITAL	Alarm threshold type.
-	configuration.conditionName `string` OPTIONAL	/systemAlerts: ALARM	System alert condition name.
-	asset.ibx `string` OPTIONAL	/systemAlerts: WA3	IBX data center identifier.
-	asset.assetUid `string` OPTIONAL	/systemAlerts: PA8A.CB-CRITICAL-DB2:tripped#DIGITAL:ALARM	Asset identifier.
-	asset.assetUnderMaintenance `string` OPTIONAL	/systemAlerts: false	Indicates if the asset was under maintenance during alert processing.
-	asset.assetType `string` OPTIONAL	/systemAlerts: Circuit Breaker with Metering	Identifies asset template.
-	asset.assetClassification `string` OPTIONAL	/systemAlerts: Electrical	Asset classification category.
-	activeProcessing.edgeCollectedOn `string` OPTIONAL	/systemAlerts: 2022-09-23T13:40:53.449276Z	Tag point reading timestamp.

Sample response

/alarms

{
    "alarms": [
        {
            "ibx": "DC5",
            "accountNo": "1",
            "assetId": "DC5.UPS-R1",
            "assetType": "UPS",
            "assetClassification": "Electrical",
            "conditionName": "Alarm",
            "status": true,
            "tagId": "DC5.UPS-R1:alarm",
            "timeProcessed": 1550519327497,
            "timeTrigerred": 1546510663707,
            "timeNormalProcessed": 0
        }
    ],
    "groupedAlarms": null,
    "totalCount": 1
}

/systemAlerts

{
    "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
            }
        }
    ],
    "pagination": {
        "offset": 20,
        "limit": 10,
        "total": 1
    }
}

/alarms request	/systemAlerts request	Example	Description
ibx `string`	asset.ibx `string`	DC5	IBX data center identifier.
accountNo `string`	-	/alarms: 1	Customer account number.
assetId `string`	asset.assetUid `string`	LD9.Generator-DH09-PG2	Asset identifier.
assetType `string`	asset.assetType `string`	Generator	Indicates asset template.
assetClassification `string`	asset.assetClassification `string`	Electrical	Asset classification category.
conditionName `string`	configuration.conditionName `string`	/alarms: Alarm /systemAlerts: ALARM	conditionName values returned by the /alarms endpoint are title case while the values returned by the /systemAlerts endpoint are uppercase.
status `boolean`	status `string`	/alarms: false /systemAlerts: ACTIVE	Different data types.
tagId `string`	assetTagUid `string`	DC5.UPS-R1:alarm	Asset tag point identifier.
timeProcessed `integer`	activeProcessing.processingEndOn `string`	/alarms: 1550519327497 /systemAlerts: 2023-06-23T04:49:01.282301Z	/alarms endpoint data model uses Unix time format while the /systemAlerts uses the IETF ISO 8601 extended date/time format YYYY-MM-DDTHH:MM:SS.000+0000. This also results in different data types.
timeTrigerred `integer`	activeProcessing.processingStartOn	/alarms: 1546510663707 /systemAlerts: 2023-06-23T04:49:01.282301Z	/alarms endpoint data model uses Unix time format while the /systemAlerts uses the IETF ISO 8601 extended date/time format YYYY-MM-DDTHH:MM:SS.000+0000. This also results in different data types.
timeNormalProcessed `integer`	inactiveProcessing.processingEndOn `string`	/alarms: 1619402917194 /systemAlerts: 2023-06-23T04:49:01.282301Z	/alarms endpoint data model uses Unix time format while the /systemAlerts uses the IETF ISO 8601 extended date/time format YYYY-MM-DDTHH:MM:SS.000+0000. This also results in different data types.

Alarms to System Alerts Migration​

Alarms to System Alerts Migration