告警规则列表

接口URL

/api/v1/observe/alert/rules

请求方式

POST

Content-Type

application/json

认证方式

Bearer auth

参数名	示例值	参数类型	是否必填	参数描述
Accept	application/json	Text	是	-
Content-Type	application/json	Text	是	-

请求Body参数

{
    "ClusterID": "tidb-c65003c9",
    "Level": "critical",
    "Name": "",
    "ExprStr": ""
}

参数名	示例值	参数类型	是否必填	参数描述
ClusterID	tidb-c65003c9	String	是	-
Level	critical	String	否	告警级别。warning, critical, emergency
Name	-	String	否	规则名称
ExprStr	-	String	是	规则表达式

成功响应示例

{
    "Data": {
        "CurrentPage": 0,
        "PageSize": 10,
        "Total": 1,
        "Pages": 1,
        "Data": [
      {
        "ID": 0,
        "Name": "BLACKER_ping_latency_more_than_1s",
        "ExprStr": "max_over_time(probe_duration_seconds{job=~\"blackbox_exporter.*_icmp\"}[1m]) \u003e 1",
        "Level": "warning",
        "Duration": "60s",
        "Labels": {
          "env": "wq_cluster",
          "expr": "max_over_time(probe_duration_seconds{job=~\"blackbox_exporter.*_icmp\"}[1m]) \u003e 1",
          "level": "warning"
        },
        "Annotations": {
          "description": "cluster: wq_cluster, instance: {{ $labels.instance }}, values: {{ $value }}",
          "summary": "blackbox_exporter ping latency more than 1s",
          "value": "{{ $value }}"
        },
        "Health": "ok",
        "LastError": "",
        "EvaluationTime": 0.000249852,
        "LastEvaluation": "2024-03-28T07:36:38.372226727Z",
        "Type": "alerting",
        "State": "inactive"
          }
        ]
    },
    "Success": true
}

参数名	示例值	参数类型	参数描述
Data	-	Object
Data.Total	1	Integer
Data.Data	-	Array
Data.Data.ID	69	Integer
Data.Data.Name	testRule	String	规则名称
Data.Data.ExprStr	max_over_time(probe _duration_seconds {job=~"blackbox_exporter .*_icmp"}[1m]) > 1	String	规则表达式
Data.Data.ApplyInstance	172.17.0.2:10080	String	告警规则关联的实例 ip:port，以逗号间隔，* 表示全部
Data.Data.Level	warning	String	告警级别
Data.Data.Duration	60s	String	持续时间
Data.Data.Labels	-	Object	标签
Data.Data.Labels.env	wq_cluster	String	-
Data.Data.Labels.expr	max_over_time(probe _duration_seconds {job=~"blackbox_exporter .*_icmp"}[1m]) > 1	String	-
Data.Data.Labels.level	warning	String	-
Data.Data.Annotations	-	Object	注解
Data.Data.Annotations. description	cluster: wq_cluster, instance: , values:	String	-
Data.Data.Annotations. summary	blackbox_exporter ping latency more than 1s	String	-
Data.Data.Annotations.value		String	-
Data.Data.Health	ok	String	是否健康
Data.Data.LastError	-	String	错误
Data.Data.EvaluationTime	0.000249852	Number	评估耗时
Data.Data.LastEvaluation	2024-03-28T07:36:38.372226727Z	String	上次评估时间
Data.Data.Type	alerting	String	规则类型
Data.Data.State	inactive	String	规则状态
Success	true	Boolean	调用是否成功

results matching ""

No results matching ""