此操作用来查询指定的HBlock告警信息。
请求语法
GET /rest/v1/system/alarm/alarmId HTTP/1.1
Date: date
Host: ip:port
Authorization: authorization
请求参数
名称 描述 是否必须 alarmId 告警ID。
仅Unresolved状态的告警支持单条查询。
是
响应结果
名称 描述 alarmId 告警ID。 instanceId 告警实例ID。 instanceSnapshot 告警实例快照,即告警发生时告警实例的详细信息。 alarmRule 告警规则。 severity 告警级别:
Warning:警告。
Major:重要。
Critical:严重。
alarmStatus 告警状态:
Unresolved:告警中。
Resolved:告警已解除。
Expired:告警已失效。
duration 告警持续时长。unix时间戳(UTC),精确到毫秒。 alarmTime 告警发生时间。unix时间戳(UTC),精确到毫秒。 alarmValue 告警时数值。仅有数值型指标对应的告警会有返回此项,以下告警规则会涉及数值型指标:
AlarmNumberApproachingLimit:告警中的告警条数接近上限,显示告警中数据容量使用率,百分比,单位是%。计算公式:(告警中的告警总条数/告警中条数上限)*100%。
ResourceUsageApproachingLimit:资源用量接近使用上限,显示许可证可用容量使用率,百分比,单位是%。计算公式:(本地卷总容量/许可证允许的容量)*100%。
CapacityQuotaUsageExceedsThreshold:配额使用率超阈值,显示存储池或数据目录关联磁盘的配额使用率(Path_Cap_Quota_Rate),百分数,单位是%。
CapacityQuotaUsageApproachLimit:配额用尽,显示存储池或数据目录关联磁盘的配额使用率(Path_Cap_Quota_Rate),百分数,单位是%。
DiskUsageExceedsThreshold:磁盘使用率超阈值,显示存储池或数据目录关联磁盘的使用率(Path_Rate),百分数,单位是%。
InsufficientSpaceonInstallationPath:安装目录剩余空间不足,显示目录所在磁盘的文件系统剩余空间,单位是GiB。
currentValue 当前数值。仅有数值型指标对应的告警会有返回此项,以下告警规则会涉及数值型指标:
AlarmNumberApproachingLimit:告警中的告警条数接近上限,显示告警中数据容量使用率,百分比,单位是%。计算公式:(告警中的告警总条数/告警中条数上限)*100%。
ResourceUsageApproachingLimit:资源用量接近使用上限,显示许可证可用容量使用率,百分比,单位是%。计算公式:(本地卷总容量/许可证允许的容量)*100%。
CapacityQuotaUsageExceedsThreshold:配额使用率超阈值,显示存储池或数据目录关联磁盘的配额使用率(Path_Cap_Quota_Rate),百分数,单位是%。
CapacityQuotaUsageApproachLimit:配额用尽,显示存储池或数据目录关联磁盘的配额使用率(Path_Cap_Quota_Rate),百分数,单位是%。
DiskUsageExceedsThreshold:磁盘使用率超阈值,显示存储池或数据目录关联磁盘的使用率(Path_Rate),百分数,单位是%。
InsufficientSpaceonInstallationPath:安装目录剩余空间不足,显示目录所在磁盘的文件系统剩余空间,单位是GiB。
muteStatus 静默状态:
Muted:静默。
Normal:正常。
muteDueTime 静默截止时间,unix时间戳(UTC),精确到毫秒。
如果多次静默,返回最后一次操作的静默截止时间。
muteOperations 静默操作,包含:operTime、operType、reason、dueTime。
类型:数组
operTime 静默操作时间。 operType 静默操作类型:
Mute:静默。
AutoUnmute:自动解除静默。
ManualUnmute:手动解除静默。
reason 静默/解除静默的原因。 dueTime 静默截止时间。
请求示例
查询告警ID为4jlhtUel的告警信息。
GET /rest/v1/system/alarm/4jlhtUel HTTP/1.1
Date: Mon, 8 Jan 2024 05:42:22 GMT
Host: 192.168.0.110:1443
Authorization: HBlock userName:signature
响应示例
HTTP/1.1 200 OK
Date: Mon, 8 Jan 2024 05:42:22 GMT
Content-Type: application/json; charset=utf-8
Content-Length: 268
Connection: keep-alive
x-hblock-request-id: dea2f8c199624d33aed3c4daa4654c2a
Server: HBlock
{
"data": {
"alarmId": "4jlhtUel",
"instanceId": "hblock_4",
"instanceSnapshot": "hblock_4,ecs-9689-0915141,192.168.0.202",
"alarmRule": "ProtocolServiceAbnormal",
"severity": "Major",
"alarmStatus": "Unresolved",
"duration": 10718615,
"alarmTime": 1704681783540,
"muteStatus": "Normal"
}
}