此操作用來查詢HBlock告警信息。
注意
告警狀態為告警中的數據存儲上限為10000條,達到上限后,新的告警無法觸發。屆時請盡快解決相關故障,或者嘗試手動解除告警。
請求語法
GET /rest/v1/system/alarm?alarmStatus=alarmStatus&filter=filter&range=i-j HTTP/1.1
Date: date
Host: ip:port
Authorization: authorization請求參數
| 名稱 | 類型 | 描述 | 是否必須 |
|---|---|---|---|
| alarmStatus | String | 告警狀態:
默認值為Unresolved。 說明 已解除、已失效數據僅支持查詢最近10000條。告警中的數據超出10000條告警,功能將不可用。 | 否 |
| filter | String | 設置查詢的過濾條件。可以選擇多個查詢,如果是或的關系,使用or將查詢條件分隔開;如果是與的關系,使用and將查詢條件分隔開。 支持的查詢類型包括:
| 否 |
| range | String | 查詢范圍,格式:i-j,其中i,j是正整數,i小于j,j-i < 1000。按照alarmTime進行逆序排序,返回第i條到第j條的告警。 如果輸入的查詢范圍超過告警的總個數,那么返回空結果集。 如果不輸入range參數,那么返回所有符合條件的告警。 | 否 |
響應結果
| 名稱 | 類型 | 描述 |
|---|---|---|
| totalCount | Integer | 符合查詢條件的告警條數。 |
| alarmList | Array of alarmList | 告警列表,詳見“表1 響應參數alarmList說明”。 |
表1 響應參數alarmList說明
| 名稱 | 類型 | 描述 |
|---|---|---|
| alarmId | String | 告警ID。 |
| instanceId | String | 告警實例ID。 |
| instanceSnapshot | String | 告警實例快照,即告警發生時告警實例的詳細信息。 |
| alarmRule | String | 告警規則。 |
| severity | Enum | 告警級別:
|
| alarmStatus | Enum | 告警狀態:
|
| duration | Long | 告警持續時長。unix時間戳(UTC),精確到毫秒。 |
| alarmTime | Long | 告警發生時間。unix時間戳(UTC),精確到毫秒。 |
| muteStatus | Enum | 靜默狀態:
|
| alarmValue | String | 告警時數值。僅有數值型指標對應的告警會有返回此項,以下告警規則會涉及數值型指標:
|
| currentValue | String | 當前數值。僅有數值型指標對應的告警會有返回此項,以下告警規則會涉及數值型指標:
|
| resolveTime | Long | 告警解除時間。unix時間戳(UTC),精確到毫秒。 Resolved狀態的告警會返回此字段。 |
| resolveValue | String | 解除告警時的數值。僅有數值型指標對應的告警會有返回此項:
|
| resolveType | Enum | 告警解除方式:
|
| expireTime | Long | 告警失效時間。 Expired狀態的告警會返回此字段。 |
| reason | String | 告警解除原因或告警失效原因。 |
| muteDueTime | Long | 靜默截止時間,unix時間戳(UTC),精確到毫秒。 如果多次靜默,返回最后一次操作的靜默截止時間。 |
| muteOperations | Array of muteOperation | 靜默操作,詳見“表2 響應參數muteOperation說明”。 |
表2 響應參數muteOperation說明
| 名稱 | 類型 | 描述 |
|---|---|---|
| operTime | Long | 靜默操作時間。 |
| operType | Enum | 靜默操作類型:
|
| reason | String | 靜默/解除靜默的原因。 |
| dueTime | Long | 靜默截止時間。 |
請求示例1
查詢告警中的告警信息。
GET /rest/v1/system/alarm?alarmStatus=Unresolved HTTP/1.1
Date: Mon, 8 Jan 2024 03:26:58 GMT
Host: 192.168.0.110:1443
Authorization: HBlock userName:signature響應示例1
HTTP/1.1 200 OK
Date: Mon, 8 Jan 2024 03:26:58 GMT
Content-Type: application/json; charset=utf-8
Content-Length: 1448
Connection: keep-alive
x-hblock-request-id: 0ba4372189a8470ca43fb8bea7959bf5
Server: HBlock
{
"data": {
"totalCount": 5,
"alarmList": [
{
"alarmId": "4jlSnwld",
"instanceId": "hblock_3:/mnt/stor",
"instanceSnapshot": "hblock_3:/mnt/stor",
"alarmRule": "CapacityQuotaUsageExceedsThreshold",
"severity": "Warning",
"alarmStatus": "Unresolved",
"duration": 346407,
"alarmTime": 1704684071663,
"alarmValue": "93.69",
"currentValue": "92.63",
"muteStatus": "Normal"
},
{
"alarmId": "4jlSnJ9h",
"instanceId": "hblock_3",
"instanceSnapshot": "hblock_3",
"alarmRule": "CapacityQuotaUsageExceedsThreshold",
"severity": "Warning",
"alarmStatus": "Unresolved",
"duration": 346861,
"alarmTime": 1704684071209,
"alarmValue": "93.69",
"currentValue": "92.63",
"muteStatus": "Normal"
},
{
"alarmId": "4jlSmXuZ",
"instanceId": "hblock_3:/mnt/stor",
"instanceSnapshot": "hblock_3,ecs-9689-0915140,192.168.0.102:/mnt/stor",
"alarmRule": "FaultDomainWarning",
"severity": "Warning",
"alarmStatus": "Unresolved",
"duration": 347413,
"alarmTime": 1704684070657,
"muteStatus": "Normal"
},
{
"alarmId": "4jlSmPPo",
"instanceId": "hblock_3:/mnt/stor",
"instanceSnapshot": "hblock_3,ecs-9689-0915140,192.168.0.102:/mnt/stor",
"alarmRule": "DataServiceHealthStatusWarning",
"severity": "Warning",
"alarmStatus": "Unresolved",
"duration": 347608,
"alarmTime": 1704684070462,
"muteStatus": "Normal"
},
{
"alarmId": "4jlhtUel",
"instanceId": "hblock_4",
"instanceSnapshot": "hblock_4,ecs-9689-0915141,192.168.0.202",
"alarmRule": "ProtocolServiceAbnormal",
"severity": "Major",
"alarmStatus": "Unresolved",
"duration": 2634530,
"alarmTime": 1704681783540,
"muteStatus": "Normal"
}
]
}
}請求示例2
查詢已解除的告警信息。
GET /rest/v1/system/alarm?alarmStatus=Resolved HTTP/1.1
Date: Mon, 8 Jan 2024 05:34:23 GMT
Host: 192.168.0.110:1443
Authorization: HBlock userName:signature響應示例2
HTTP/1.1 200 OK
Date: Mon, 8 Jan 2024 05:34:23 GMT
Content-Type: application/json; charset=utf-8
Content-Length: 3268
Connection: keep-alive
x-hblock-request-id: b47f7f2aae794363bc577eb304425122
Server: HBlock
{
"data": {
"totalCount": 10,
"alarmList": [
{
"alarmId": "4jlSnwld",
"instanceId": "hblock_3:/mnt/stor",
"instanceSnapshot": "hblock_3:/mnt/stor",
"alarmRule": "CapacityQuotaUsageExceedsThreshold",
"severity": "Warning",
"alarmStatus": "Resolved",
"duration": 603073,
"alarmTime": 1704684071663,
"alarmValue": "93.69",
"resolveTime": 1704684674736,
"resolveValue": "5.06",
"resolveType": "Auto",
"muteStatus": "Normal"
},
{
"alarmId": "4jlSnJ9h",
"instanceId": "hblock_3",
"instanceSnapshot": "hblock_3",
"alarmRule": "CapacityQuotaUsageExceedsThreshold",
"severity": "Warning",
"alarmStatus": "Resolved",
"duration": 603023,
"alarmTime": 1704684071209,
"alarmValue": "93.69",
"resolveTime": 1704684674232,
"resolveValue": "5.06",
"resolveType": "Auto",
"muteStatus": "Normal"
},
{
"alarmId": "4jlSmXuZ",
"instanceId": "hblock_3:/mnt/stor",
"instanceSnapshot": "hblock_3,ecs-9689-0915140,192.168.0.102:/mnt/stor",
"alarmRule": "FaultDomainWarning",
"severity": "Warning",
"alarmStatus": "Resolved",
"duration": 603430,
"alarmTime": 1704684070657,
"resolveTime": 1704684674087,
"resolveType": "Auto",
"muteStatus": "Normal"
},
{
"alarmId": "4jlSmPPo",
"instanceId": "hblock_3:/mnt/stor",
"instanceSnapshot": "hblock_3,ecs-9689-0915140,192.168.0.102:/mnt/stor",
"alarmRule": "DataServiceHealthStatusWarning",
"severity": "Warning",
"alarmStatus": "Resolved",
"duration": 602999,
"alarmTime": 1704684070462,
"resolveTime": 1704684673461,
"resolveType": "Auto",
"muteStatus": "Normal"
},
{
"alarmId": "4ilZH7wX",
"instanceId": "hblock_1",
"instanceSnapshot": "hblock_1,hblockserver,192.168.0.110",
"alarmRule": "ProtocolServiceAbnormal",
"severity": "Major",
"alarmStatus": "Resolved",
"duration": 230649424,
"alarmTime": 1704446197387,
"resolveTime": 1704676846811,
"resolveType": "Auto",
"muteStatus": "Normal"
},
{
"alarmId": "4hDwJnaH",
"instanceId": "hblock_3",
"instanceSnapshot": "hblock_3,ecs-9689-0915140,192.168.0.102",
"alarmRule": "ProtocolServiceAbnormal",
"severity": "Major",
"alarmStatus": "Resolved",
"duration": 361874,
"alarmTime": 1704275265260,
"resolveTime": 1704275627134,
"resolveType": "Auto",
"muteStatus": "Normal"
},
{
"alarmId": "4hD1BMWS",
"instanceId": "hblock_4",
"instanceSnapshot": "hblock_4,ecs-9689-0915141,192.168.0.202",
"alarmRule": "ProtocolServiceAbnormal",
"severity": "Major",
"alarmStatus": "Resolved",
"duration": 2291572,
"alarmTime": 1704273335042,
"resolveTime": 1704275626614,
"resolveType": "Auto",
"muteStatus": "Normal"
},
{
"alarmId": "4hD2AgSt",
"instanceId": "hblock_1:/mnt/stor",
"instanceSnapshot": "hblock_1,hblockserver,192.168.0.110:/mnt/stor",
"alarmRule": "FaultDomainError",
"severity": "Major",
"alarmStatus": "Resolved",
"duration": 61433,
"alarmTime": 1704273396083,
"resolveTime": 1704273457516,
"resolveType": "Auto",
"muteStatus": "Normal"
},
{
"alarmId": "4hD2zESY",
"instanceId": "hblock_1:/mnt/stor",
"instanceSnapshot": "hblock_1,hblockserver,192.168.0.110:/mnt/stor",
"alarmRule": "DataServiceHealthStatusError",
"severity": "Major",
"alarmStatus": "Resolved",
"duration": 61164,
"alarmTime": 1704273395799,
"resolveTime": 1704273456963,
"resolveType": "Auto",
"muteStatus": "Normal"
},
{
"alarmId": "4hCtBCK5",
"instanceId": "hblock_4:/mnt/storage01",
"instanceSnapshot": "hblock_4,ecs-9689-0915141,192.168.0.202:/mnt/storage01",
"alarmRule": "DataServiceHealthStatusError",
"severity": "Major",
"alarmStatus": "Resolved",
"duration": 60395,
"alarmTime": 1704271227603,
"resolveTime": 1704271287998,
"resolveType": "Auto",
"muteStatus": "Normal"
}
]
}
}請求示例3
查詢告警中、告警級別為Major的告警信息。
GET /rest/v1/system/alarm?alarmStatus=Unresolved&filter=severity:Major HTTP/1.1
Date: Mon, 8 Jan 2024 05:38:29 GMT
Host: 192.168.0.1110:1443
Authorization: HBlock userName:signature響應示例3
HTTP/1.1 200 OK
Date: Mon, 8 Jan 2024 05:38:29 GMT
Content-Type: application/json; charset=utf-8
Content-Length: 299
Connection: keep-alive
x-hblock-request-id: 988b145267ac41c886954b6f81598ec4
Server: HBlock
{
"data": {
"totalCount": 1,
"alarmList": [
{
"alarmId": "4jlhtUel",
"instanceId": "hblock_4",
"instanceSnapshot": "hblock_4,ecs-9689-0915141,192.168.0.202",
"alarmRule": "ProtocolServiceAbnormal",
"severity": "Major",
"alarmStatus": "Unresolved",
"duration": 10526372,
"alarmTime": 1704681783540,
"muteStatus": "Normal"
}
]
}
}