告警事件列表
获取告警事件列表,由于涉及到多个参数过滤,故使用了 POST 请求,实际仅仅是获取,未做变更,可放心请求
接口URL
/api/v1/observe/alert/events
请求方式
POST
Content-Type
application/json
认证方式
Bearer auth
请求Header参数
参数名 | 示例值 | 参数类型 | 是否必填 |
参数描述 |
---|---|---|---|---|
Accept | application/json | Text | 是 | - |
Content-Type | application/json | Text | 是 | - |
请求Body参数
{
"Keyword": "TiDB",
"Level": 1,
"Status": 2,
"StartTime": "2024-03-31 14:28:00",
"EndTime": "2024-04-01 14:28:59",
"CurrentPage": 1,
"PageSize": 10
}
参数名 | 示例值 | 参数类型 | 是否必填 | 参数描述 |
---|---|---|---|---|
Keyword | TiDB | String | 否 | 关键词搜索 |
Level | 1 | Integer | 否 | 告警级别,1:warning, 2:critical,3:emergency |
Status | 2 | Integer | 否 | 告警状态,1:alerting, 2:resolved,3:ignored |
StartTime | 2024-03-31 14:28:00 | String | 否 | - |
EndTime | 2024-04-01 14:28:59 | String | 否 | - |
CurrentPage | 1 | Integer | 否 | - |
PageSize | 10 | Integer | 否 | - |
成功响应示例
{
"Data": {
"CurrentPage": 1,
"PageSize": 10,
"Total": 2,
"Pages": 1,
"Data": [
{
"EventID": "event-7700056557439324",
"Level": 1,
"Instance": "172.18.4.0:10080",
"Job": "tidb",
"Expr": "changes(process_start_time_seconds{job=\"tidb\"}[5m]) > 0",
"StartTime": "2024-03-31T20:00:14.789+08:00",
"ResolvedTime": {
"Time": "2024-03-31T20:02:23.414+08:00",
"Valid": true
},
"Status": 2,
"Summary": "TiDB server has been restarted",
"Description": "cluster: tidb-2af54607, instance: 172.18.4.0:10080, values:1",
"Value": "1",
"AlertName": "TiDB_node_restart",
"ClusterID": "",
"TiUPCluster": "tidb-2af54607"
},
]
},
"Success": true
}
参数名 | 示例值 | 参数类型 | 参数描述 |
---|---|---|---|
Data | - | Object | |
Data. CurrentPage |
0 | Integer | |
Data.PageSize | 10 | Integer | |
Data.Total | 1 | Integer | |
Data.Pages | 1 | Integer | |
Data.Data | - | Array | |
Data.Data. EventID |
event-0147 633563534909 |
String | 事件ID |
Data.Data.Level | 2 | Integer | 告警级别 |
Data.Data. Instance |
172.18.4.0:10080 | String | 告警对象,为 ip:port 代表的 TiKV, TiDB, PD 或 TiFlash 实例 |
Data.Data. Job |
tidb | String | prometheus job 名称 |
Data.Data. Expr |
changes(process_start_time _seconds{job="tidb"}[5m]) > 0 |
String | promQL 表达式,告警规则 |
Data.Data. StartTime |
2023-09-22 T15:55:05.895+08:00 |
String | |
Data.Data. ResolvedTime |
- | Object | |
Data.Data. ResolvedTime. Time |
0001-01-01 T00:00:00Z |
String | |
Data.Data. ResolvedTime. Valid |
false | Boolean | |
Data.Data. Status |
1 | Integer | 告警状态: |
Data.Data. Summary |
BR failed: FullBackup tidb-0d2d74acf23e53be (tidbv7.1.1-0) |
String | |
Data.Data. Description |
cluster: tidb-2af54607, instance: 172.18.4.0:10080, values:1 | String | - |
Data.Data. Value |
1 | String | - |
Data.Data. AlertName |
BackupRestoreFailed | String | |
Data.Data. ClusterID |
tidb-0d2d74acf23e53be | String | 集群 ID |
Data.Data. TiUPCluster |
tidb-2af54607 | String | tiup 的集群 ID |
Success | true | Boolean | 调用是否成功 |