Skip to main content

Effective 10 September 2024, API Documentation can be found on our Equinix Product Documentation site.
The content on this page will not be updated after 1 Oct 2024 and will be inaccessible after 31st Dec 2024.


System Alerts v2

Retrieve System Alerts​

 POST /smartview/v2/systemAlerts/search
MethodPOST
Endpoint/smartview/v2/systemAlerts/search
HeadersAuthorization, Content-Type
Path ParametersNot applicable
Query ParametersNot applicable
Body Parametersfilter, pagination, sort

This API request returns system alerts that match provided search criteria.

 

For instructions on how to obtain an authorization token, refer to Requesting Access and Refresh Tokens.


Sample curl request

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"
                ]
            },
            {
                "property": "/asset/ibx",
                "operator": "IN",
                "values": [
                    "MI1",
                    "NY1",
                    "WAW2"
                ]
            },
            {
                "property": "/asset/assetUid",
                "operator": "=",
                "values": [
                    "MI1.arc-reactor"
                ]
            },
            {
                "property": "/assetTagUid",
                "operator": "=",
                "values": [
                    "MI1.arc-reactor:alarm"
                ]
            },
            {
                "property": "/assetTagDisplayName",
                "operator": "=",
                "values": [
                    "Arc Reactor Alarm"
                ]
            },
            {
                "property": "/asset/assetType",
                "operator": "=",
                "values": [
                    "Arc Reactor"
                ]
            },
            {
                "property": "/asset/assetClassification",
                "operator": "=",
                "values": [
                    "Mechanical"
                ]
            },
            {
                "property": "/asset/assetUnderMaintenance",
                "operator": "=",
                "values": [
                    "false"
                ]
            },
            {
                "property": "/configuration/thresholdType",
                "operator": "=",
                "values": [
                    "DIGITAL"
                ]
            },
            {
                "property": "/configuration/conditionName",
                "operator": "=",
                "values": [
                    "ALARM"
                ]
            },
            {
                "property": "/activeProcessing/edgeCollectedOn",
                "operator": ">=",
                "values": [
                    "2000-03-25T04:03:06.000Z"
                ]
            }
        ]
    },
    "pagination": {
        "offset": 0,
        "limit": 50
    },
    "sort": [
        {
            "direction": "ASC",
            "property": "/asset/ibx"
        },
        {
            "direction": "DESC",
            "property": "/activeProcessing/edgeCollectedOn"
        }
    ]
}'

Body parameters

Parameter
Description
filter object
REQUIRED
Object defining search conditions.
and array[object]
REQUIRED
Array of search parameters.
property string
REQUIRED
Search parameter.
Applicable values:
  • /status
  • /assetTagUid
  • /assetTagDisplayName
  • /configuration/thresholdType
  • /configuration/conditionName
  • /asset/ibx
  • /asset/assetUid
  • /activeProcessing/edgeCollectedOn
  • /asset/assetUnderMaintenance
  • /asset/assetType
  • /asset/assetClassification
operator string
REQUIRED
Search parameter operator.
Applicable values:
  • =
  • !=
  • >=
  • <=
  • LIKE
  • IN
values string
REQUIRED
Search parameter value.
Example: DIGITAL
pagination object
OPTIONAL
Search results pagination settings.
offset integer
OPTIONAL
Index of the first item returned in the response.
Minimum: 0
Default: 0
limit integer
OPTIONAL
Maximum number of items returned per page.
Minimum: 1
Maximum: 100
Default: 20
sort array[object]
OPTIONAL
Search results sorting settings.

This API request supports multiple sorting parameters. Parameters are applied in the order they are listed in the request payload.

direction string
OPTIONAL
Search results sorting direction.
Applicable values:
  • ASC
  • DESC
Default: DESC
property string
OPTIONAL
Search results sorting parameter.
Applicable values:
  • /status
  • /assetTagUid
  • /assetTagDisplayName
  • /configuration/thresholdType
  • /configuration/conditionName
  • /asset/ibx
  • /asset/assetUid
  • /activeProcessing/edgeCollectedOn
  • /asset/assetUnderMaintenance
  • /asset/assetType
  • /asset/assetClassification
Default: /activeProcessing/edgeCollectedOn
/statusExample:
"property": "/status",
"operator": "=",
"values": [
    "ACTIVE"
]
operator string
REQUIRED
Search field parameter operator.
Applicable values:
  • =
  • IN
value array[string]
REQUIRED
System alert status.
Applicable values:
  • ACTIVE
  • INACTIVE
/assetTagUidExample:
"property": "/assetTagUid",
"operator": "=",
"values": [
    "PA8A.CB-CRITICAL-DB2:tripped"
]
operator string
REQUIRED
Search field parameter operator.
Applicable values:
  • =
  • IN
value array[string]
REQUIRED
Asset tag point identifier.
Example: ["PA8A.CB-CRITICAL-DB2:tripped"]
/assetTagDisplayNameExample:
"property": "/assetTagDisplayName",
"operator": "=",
"values": [
   "ALARM"
]
operator string
REQUIRED
Search field parameter operator.
Applicable values:
  • =
  • LIKE
value array[integer]
REQUIRED
Active tag display name.
Example: ["ALARM"]
/configuration/thresholdTypeExample:
"property": "/configuration/thresholdType",
"operator": "=",
"values": [
   "DIGITAL"
]
operator string
REQUIRED
Search field parameter operator.
Applicable values:
  • =
  • IN
value array[integer]
REQUIRED
Alarm threshold type.
Applicable values:
  • ABSOLUTE
  • DEVIATION
  • DIGITAL
  • MULTI_STATE
/configuration/conditionNameExample:
"property": "/configuration/conditionName",
"operator": "=",
"values": [
    "ALARM"
]
operator string
REQUIRED
Search field parameter operator.
Applicable values:
  • =
  • IN
value array[string]
REQUIRED
System alert condition name.
Applicable values:
  • ALARM
  • WARNING
  • VERY_LOW
  • LOW
  • HIGH
  • VERY_HIGH
/asset/ibxExample:
"property": "/asset/ibx",
"operator": "=",
"values": [
    "WA3"
]
operator string
REQUIRED
Search field parameter operator.
Applicable values:
  • =
  • IN
value array[integer]
REQUIRED
IBX data center identifier.
Example: ["WA3"]
/asset/assetTypeExample:
"property": "/asset/assetType",
"operator": "=",
"values": [
    "Circuit Breaker with Metering"
]
operator string
REQUIRED
Search field parameter operator.
Applicable values:
  • =
  • IN
value array[string]
REQUIRED
Identifies asset template.
Example: ["Circuit Breaker with Metering"]
/asset/assetClassificationExample:
"property": "/asset/assetClassification",
"operator": "=",
"values": [
    "0e9daf19-72bd-4ba7-b305-e0132740224b"
]
operator string
REQUIRED
Search field parameter operator.
Applicable values:
  • =
  • IN
value array[string]
REQUIRED
Asset classification category.
Applicable values:
  • Electrical
  • Environmental
  • Mechanical
/asset/assetUidExample:
"property": "/asset/assetUid",
"operator": "=",
"values": [
    "PA8A.CB-CRITICAL-DB2:tripped#DIGITAL:ALARM"
]
operator string
REQUIRED
Search field parameter operator.
Applicable values:
  • =
  • IN
  • LIKE
value array[integer]
REQUIRED
Asset identifier.
Example: ["PA8A.CB-CRITICAL-DB2:tripped#DIGITAL:ALARM"]
/activeProcessing/edgeCollectedOnExample:
"property": "/activeProcessing/edgeCollectedOn",
"operator": "=",
"values": [
    "SV"
]
operator string
REQUIRED
Search field parameter operator.
Applicable values:
  • =
  • >=
  • <=
value array[string]
REQUIRED
Tag point reading timestamp.
Example: ["2022-09-23T13:40:53.449276Z"]
/asset/assetUnderMaintenanceExample:
"property": "/asset/assetUnderMaintenance",
"operator": "=",
"values": [
    "false"
]
operator string
REQUIRED
Search field parameter operator.
Applicable values:
  • =
  • IN
value array[string]
REQUIRED
Indicates if the asset was under maintenance during alert processing.
Applicable values:
  • false
  • true

Sample response

{
    "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
    }
}

Response payload body description

Parameter
Description
data array[object]
Data array containing search results.
id integer
System alert database entry identifier.
Example: 420
alertUid string
System alert identifier.
Example: PA8A.CB-CRITICAL-DB2:tripped#DIGITAL:ALARM
traceUid string
Identifies a specific system alert trigger event instance.
Example: 1652686263561/PA8A.CB-CRITICAL-DB2:tripped#DIGITAL:ALARM
assetTagUid string
Asset tag point identifier.
Example: assetTagUid
assetTagDisplayName string
Asset tag point display name.
Example: Temperature
status string
System alert status.
Possible values:
  • ACTIVE
  • INACTIVE
value object
Value of the tag point reading related to a given system alert.
alertTagValue string
Tag point reading raw value.
Example: 1
alertTagValueDisplayName object
Tag point reading displayed value.
Example: NORMAL
activeAlertTagValueDisplayName object
Tag point reading displayed value when active.
Example: ALARM
currentTagValue object
Current tag reading display value.
Example: NORMAL
asset object
Asset information.
ibx string
Identifier of the IBX data center where the asset is located.
Example: WA3
assetUid string
Asset identifier.
Example: PA8A.CB-CRITICAL-DB2
assetType string
Indicates asset template.
Example: Circuit Breaker with Metering
assetClassification string
Asset classification category.
Example: 1-129105284100
assetRegion string
Broad geographical region where the asset is located.
Example: EMEA
assetUnderMaintenance boolean
Indicates if the asset is undergoing maintenance.
Example: false
configuration object
System alert configuration information.
thresholdValue string
System alert trigger threshold value.
Example: 0
thresholdValueDisplayName string
Threshold value display name.
Example: ALARM
unitOfMeasurement string
Tag point reading unit of measurement.
Example: °C
thresholdType string
System alert threshold type.
Possible values:
  • ABSOLUTE
  • DEVIATION
  • DIGITAL
  • MULTI_STATE
conditionName string
System alert trigger condition name.
Possible values:
  • ALARM
  • WARNING
  • VERY_LOW
  • LOW
  • HIGH
  • VERY_HIGH
configurationVersion string
System alert configuration revision.
Example: 1.0
activeProcessing object
Processing details for when the system alert has been triggered.
edgeCollectedOn string
Timestamp when the reading was taken.
Example: 2023-01-11T16:06:10.082Z
tagCalculationJobProcessedOn string
Timestamp when tag reading was processed by tag-calculation RTP.
Example: 2023-01-11T16:06:10.082Z
processingStartOn string
Timestamp when the tag reading was accepted by the alert RTP.
Example: 2023-01-11T16:06:10.082Z
processingEndOn string
Timestamp when the tag processing was completed.
Example: 2023-01-11T16:06:10.082Z
publishedOn string
Timestamp when the tag reading was published by the alert RTP.
Example: 2023-01-11T16:06:10.082Z
inactiveProcessing object
Processing details for when the system alert has been normalized.
edgeCollectedOn string
Timestamp when the reading was taken.
Example: 2023-01-11T16:06:10.082Z
tagCalculationJobProcessedOn string
Timestamp when tag reading was processed by tag-calculation RTP.
Example: 2023-01-11T16:06:10.082Z
processingStartOn string
Timestamp when the tag reading was accepted by the alert RTP.
Example: 2023-01-11T16:06:10.082Z
processingEndOn string
Timestamp when the tag processing was completed.
Example: 2023-01-11T16:06:10.082Z
publishedOn string
Timestamp when the tag reading was published by the alert RTP.
Example: 2023-01-11T16:06:10.082Z
pagination object
Search results pagination settings.
offset integer
Index of the first item returned in the response.
Example: 0
limit integer
Maximum number of items returned per page.
Example: 20
total integer
Total number of items in the dataset.
Example: 20