查询告警个数
功能介绍
应用服务器可调用此接口在设施云平台查询告警数量。
URI
POST /v1/iotfm/alarms/count
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数说明：用户Token。通过调用 生成Token 接口获取，接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。 |
| X-Instance-Id | 是 | String | 参数说明：实例ID。通过访问智能设施云平台界面后获取，智能设施云平台资源均为实例级隔离，所有业务接口必须填写正确的实例ID才能被成功调用。 取值范围：长度8-36，只允许大小写字母、数字和-字符的组合。 |
| X-Root-Zone-Id | 否 | String | 参数说明：项目ID。 取值范围：长度不超过24，只允许字母、数字的组合。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| alarm_levels | 否 | Array of strings | 参数说明：告警等级列表。 取值范围：当前支持枚举值：Critical、 Major、Minor、Info。 |
| alarm_statuses | 否 | Array of strings | 参数说明：告警状态列表。 取值范围：当前支持枚举值：CREATED、CLOSED。 |
| device_id | 否 | String | 参数说明：设备ID，用于唯一标识一个设备，在注册设备时由设施云平台分配获得。 取值范围：长度不超过128，只允许字母、数字、下划线（_）、连接符（-）的组合。 |
| device_name | 否 | String | 参数说明：设备名称。 取值范围：长度不超过64，只允许中文、字母、数字、以及_?'#().,&%@!-字符的组合。 |
| alarm_source_types | 否 | Array of strings | 参数说明：告警来源类型。 |
| product_name | 否 | String | 参数说明：产品名称。 取值范围：长度不超过64，只允许中文、字母、数字、以及_-字符的组合。 |
| product_ids | 否 | Array of strings | 产品ID列表 |
| alarm_name | 否 | String | 参数说明：告警名称。 取值范围：长度不超过64，只允许中文、字母、数字、以及_-字符的组合。 |
| start_time | 否 | String | 参数说明：开始时间。 取值范围："yyyy-MM-dd'T'HH:mm:ss.SSS'Z'"。 |
| end_time | 否 | String | 参数说明：结束时间。 取值范围："yyyy-MM-dd'T'HH:mm:ss.SSS'Z'"。 |
| zone_id | 否 | String | 参数说明：区域ID， 设备所在的区域ID。 取值范围：长度不超过24，只允许字母、数字的组合。 |
| is_freq_alarm | 否 | Boolean | 参数说明：是否过滤出高频告警。 |
响应参数
状态码：200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| count | Long | 参数说明：告警数量。 |
状态码：400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数说明：错误码。 取值范围：长度8-36。 |
| error_msg | String | 参数说明：错误描述。 取值范围：长度2-512。 |
请求示例
查询告警个数
POST https://{endpoint}/v1/iotfm/alarms/count
{
"page" : {
"offset" : 0,
"limit" : 10
},
"alarm_statuses" : [ "CREATED" ]
} 响应示例
状态码：200
OK
{
"count" : 10
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | OK |
| 400 | Bad Request |
| 403 | Forbidden |
| 404 | Not Found |
| 500 | Internal Server Error |
