告警
2.3.1按条件查询实时告警
接口地址
GET /NSphere/api/alarm-resource/real-time-alarms
接口描述
按条件查询实时告警。E0930版本新增接口。
请求数据类型
application/x-www-form-urlencoded
响应数据类型
application/json
请求参数
参数名称 | 参数说明 | 请求类型 | 必须 | 数据类型 | schema |
offset | 偏移量。指定从第几条记录开始返回。 | query | false | integer(int32) | |
limit | 每页返回的最大记录数。 | query | false | integer(int32) | |
sortDir | 排序类型，0：不排序，1：升序，2：降序，sortField不为空时默认不排序。 | query | false | integer(int32) | |
sortField | 排序字段。支持字段：state（确认状态），eventLevel（级别），category（类型），eventSrc（告警来源），eventDesc（告警信息），eventTime（最新告警时间），firstEventTime（首次告警时间），eventCount（重复次数）。 | query | false | string | |
state | 确认状态：1 已确认 2 未确认。 | query | false | integer(int32) | |
eventLevel | 告警级别：1 紧急 2 重要 3 次要 4 提示。 | query | false | array | integer |
category | 类型：1 主机资源告警 2 虚拟机资源告警 3 集群资源告警 4 故障告警 6 其他异常告警 7 安全告警 10 网络亚健康告警 20 分布式存储资源告警 80 容器引擎告警 90 奇安信告警。 | query | false | integer(int32) | |
targetType | 告警源对象类型，目前支持如下类型：1 集群，2 主机，3 虚拟机，7 主机存储，9 集群共享存储。targetType需与targetId或者targetName组合使用。当targetType=7时，需要同时指定targetId与targetName，targetId代表主机ID，targetName代表存储池名称。当targetType=9时，targetId无作用，需要指定targetName。 | query | false | integer(int32) | |
targetId | 告警源对象ID。targetType不为空时生效。 | query | false | integer(int64) | |
targetOnly | 是否不查询告警源对象的子对象信息，true 不查询子对象信息，false 要查询子对象信息。默认为false，targetType不为空时生效。 | query | false | boolean | |
targetName | 告警源对象名称，目前只当targetType为7或者9时才有意义，表示存储池名称（注意不是显示名称）。 | query | false | string |
响应状态
状态码 | 说明 | schema |
200 | OK | ApiResponseApiPagingListResultApiRealTimeAlarmVO |
响应参数
参数名称 | 参数说明 | 类型 | schema |
state | 状态码 0: 成功, 1: 失败, 2: 部分成功 | integer(int32) | integer(int32) |
errorCode | 错误码 当不为0表示业务发生错误 | integer(int32) | integer(int32) |
successMessage | 成功消息 | string | |
failureMessage | 错误消息，失败或者部分成功时有效. | string | |
data | 响应数据，如果状态码为0表示正常的数据返回，如果非0且非空则代表引起异常的必要数据 | ApiPagingListResultApiRealTimeAlarmVO | ApiPagingListResultApiRealTimeAlarmVO |
data | 告警信息。 | array | ApiRealTimeAlarmVO |
id | 告警ID。 | integer(int64) | |
catalogId | 告警类型ID。 | integer(int64) | |
category | 告警类型。 | integer(int32) | |
state | 确认状态：1 已确认 2 未确认。 | integer(int32) | |
eventLevel | 告警级别：1 紧急 2 重要 3 次要 4 提示。 | integer(int32) | |
eventType | 告警类型。 10以内:没规律; 20:主机类; 30:虚拟机类; 40:集群类; 50:其他类; 60:安全类; 70:onestor类 80:云容器引擎类 90:奇安信类。 | integer(int32) | |
eventName | 告警名称。 | string | |
eventSrc | 告警来源。 | string | |
eventTime | 最新告警时间，格式为以毫秒为单位的时间戳：示例：1776755870801。 | string(date-time) | |
firstEventTime | 首次告警时间，格式为以毫秒为单位的时间戳：示例：1776755870801。 | string(date-time) | |
eventDesc | 告警信息。 | string | |
targetId | 告警源对象ID，虚拟机Id、主机Id等，此字段与具体的告警类型有关。 | integer(int64) | |
uuid | 虚拟机类型告警添加uuid。 | string | |
childTarget | 特定告警的子对象。 | string | |
eventCount | 重复次数。 | integer(int32) | |
confirmTime | 告警确认时间，格式为以秒为单位的时间戳。 | integer(int64) | |
objectNameMd | 告警对象名称，记录kaas产生告警的对象名称的MD5值。 | string | |
onestorAlarmKey | 每一条新版onestor的唯一标识, NSphere的告警此字段为null。 | string | |
cdpAlarmId | CDP告警ID。 | string | |
offset | 偏移量。指定从第几条记录开始返回。 | integer(int32) | |
size | 当前返回的记录数。 | integer(int32) | |
total | 数据总量 | integer(int64) |
响应示例
{
"state": 0,
"errorCode": 0,
"successMessage": null,
"failureMessage": null,
"data": {
"data": [
{
"id": null,
"catalogId": null,
"category": null,
"state": null,
"eventLevel": null,
"eventType": null,
"eventName": null,
"eventSrc": null,
"eventTime": null,
"firstEventTime": null,
"eventDesc": null,
"targetId": null,
"uuid": null,
"childTarget": null,
"eventCount": null,
"confirmTime": null,
"objectNameMd": null,
"onestorAlarmKey": null,
"cdpAlarmId": null
}
],
"offset": null,
"size": null,
"total": null
}
}