使用参数获取警报列表
此 API 可以使用参数获取警报列表。
请求
GET /api/v2/alarms?clientID={clientID}&facilityID={facilityID}&deviceID={deviceID}&endpointID={deviceID}&maxCount={maxCount} HTTP/1.1
Host: gear.cloud.studio
Authorization: Bearer {accessToken}参数
| 名称 | 说明 |
|---|---|
| accessToken | 具有警报信息读取权限的访问令牌。更多信息请参见此页面。访问令牌也可以通过查询字符串中的 "accessToken" 参数发送。 |
| clientID | 可选标识符,表示只获取指定客户的警报。 |
| facilityID | 可选标识符,表示只获取指定设施的警报。 |
| deviceID | 可选标识符,表示只获取指定设备的警报。 |
| dateFrom | 获取指定设备警报的起始日期。 |
| dateTo | 获取指定设备警报的截止日期。 |
| endpointID | 可选标识符,表示只获取指定端点的提醒。 |
| state | 警报状态标识符。可能的值为 "open"、"closed" 和 "all"。 |
| maxCount | 可选参数,表示结果中包含的最大记录数。大于 500 的值一律按 500 处理,无论请求中发送的值是多少。 |
| 必须包含 "clientID"、"facilityID"、"deviceID" 或 "endpointID" 参数中的一个(且只能一个)。 |
|---|
响应
响应包含匹配的警报列表,如下例所示:
[
{
"AlarmID":1266896,
"DeviceID":7370,
"DeviceDescription":"Controlador RUPANCO",
"EndpointID":0,
"AlarmTypeID":1,
"AlarmTypeDescription":"Dispositivo fuera de línea",
"AlarmSeverityID":3,
"AlarmSeverityDescription":"Alta",
"Details":"",
"DateTimeCreated_UTC":"2021-10-15T17:34:35",
"DateTimeClosed_UTC":"2021-10-15T18:21:39",
"SequenceNumber":28885207,
"MTTRMinutes":47.0
},
{
"AlarmID":1266922,
"DeviceID":7370,
"DeviceDescription":"Controlador RUPANCO",
"EndpointID":0,
"AlarmTypeID":1,
"AlarmTypeDescription":"Dispositivo fuera de línea",
"AlarmSeverityID":3,
"AlarmSeverityDescription":"Alta",
"Details":"",
"DateTimeCreated_UTC":"2021-10-15T19:36:41",
"DateTimeClosed_UTC":"2021-10-15T19:37:23",
"SequenceNumber":28885384,
"MTTRMinutes":47.0
}
]最后更新于