调用GetAlertRuleList接口获取报警列表的详细信息。
使用POST方式发起请求。
下表仅列出了接口特有的请求参数和部分公共参数。完整的公共参数列表，参考公共参数。
字段 | 位置 | 类型 | 必填 | 说明 | 示例值 |
|---|---|---|---|---|---|
Action | Query | String | 是 | 公共参数，OpenAPI接口名称。 | GetAlertRuleList |
Version | Query | String | 是 | 公共参数，OpenAPI接口版本。 | 2022-07-11 |
EnableStatus | RequestBody | Boolean | 是 | 报警开关。可以为空。 | - |
AlertStatus | RequestBody | Boolean | 是 | 报警状态，是否删除。可以为空。 | - |
AlertType | RequestBody | String | 是 | 报警类型。可以为空。 | - |
Keyword | RequestBody | String | 是 | 搜索关键字。 | - |
RuleIds | RequestBody | Array[Int64] | 是 | 报警策略ID列表。 | - |
PageNo | RequestBody | Int32 | 是 | 分页编号。 | - |
PageSize | RequestBody | Int32 | 是 | 分页长度。 | - |
Result字段包含以下参数：
字段 | 类型 | 说明 |
|---|---|---|
Total | Int32 | 列表长度。 |
Rules | Array[AlertRuleDetail] | 报警详情。 |
AlertRuleDetail
字段 | 类型 | 说明 |
|---|---|---|
Id | Int32 | 公共参数，OpenAPI接口名称。 |
Config | AlertRuleConfig | 报警配置。 |
Status | AlertRuleStatus | 报警状态。 |
AlertRuleConfig
字段 | 类型 | 说明 |
|---|---|---|
Name | String | 报警名称。 |
Desc | String | 报警描述。 |
AlertStrategy | AlertStrategy | 报警策略。 |
NotifyConfig | NotifyConfig | 报警通知配置。 |
NotifyConfig
字段 | 类型 | 说明 |
|---|---|---|
NotifyInterval | Int32 | 通知间隔。 |
NotifyTypes | Array[String] | 报警类型。
|
NotifyLarkWebhooks | Array[String] | 飞书Webhook列表。 |
NotifyWebhooks | Array[String] | CommonWebhook列表。 |
NotifyGroup | Array[Int32] | 报警组ID。 |
AlertStrategy
字段 | 类型 | 说明 |
|---|---|---|
AlertType | String | 报警类型。 |
AlertLevel | Array[String] | 报警等级。 |
LogicOperator | String | 多策略关系。
|
ExecuteInterval | Int32 | 报警执行间隔。单位：分钟。 |
MetricConfig | Array[AlertMetricConfig] | 指标策略。 |
AlertMetricConfig
字段 | 类型 | 说明 |
|---|---|---|
ScanWindow | Int32 | 检测时间窗口。单位：分钟。 |
RollupTimeframeByAggregator | String | 时间窗口聚合方式。
|
AlertMetric | AlertMetric | 报警执行间隔。单位：分钟。 |
CompareConfigList | Map[AlertCompareConfig] | 指标策略。 |
AlertMetric
字段 | 类型 | 说明 |
|---|---|---|
IsFormula | Boolean | 是否为复合报警。 |
SimpleMetric | AlertSimpleMetric | 简单报警指标。当IsFormula=true时，为空。 |
FormulaMetric | AlertFormulaMetric | 复合报警指标。当IsFormula=false时，为空。 |
AlertSimpleMetric
字段 | 类型 | 说明 |
|---|---|---|
AlertSimpleMetric | Array[AlertSimpleMetric] | 简单报警指标。 |
FormulaQuery | FormulaQuery | 复合指标配置。 |
FormulaQuery
字段 | 类型 | 说明 |
|---|---|---|
Formula | String | 复合指标计算公式。 |
Alias | String | 展示名称。 |
Unit | String | 单位。 |
Alphabet | String | 计算公式使用的符号。 |
AlertSimpleMetric
字段 | 类型 | 说明 |
|---|---|---|
Ispromql | Boolean | 是否为PromQL指标。 |
Promql | String | promsql查询。 |
Metric | String | 指标名称。 |
Unit | String | 单位。 |
Alphabet | String | 计算复合指标公式使用的符号。 |
MetricCategory | String | Metric类型。
|
MetricSource | String | 指标类型。
|
GroupByFields | Array[String] | 分组。 |
Aggregator | String | 分组聚合函数。 |
AddFunc | String | 后处理函数。
|
Filters | Array[FilterCondition] | 过滤条件。 |
FilterCondition
字段 | 类型 | 说明 |
|---|---|---|
Key | String | 过滤tag名称。 |
Op | String | 过滤运算符。
|
Values | String | 单位。 |
AlertRuleStatus
字段 | 类型 | 说明 |
|---|---|---|
CreateBy | User | 报警创建用户。 |
UpdateBy | User | 最近修改用户。 |
CreateAt | Int64 | 创建时间。 |
UpdateAt | Int64 | 最近修改时间。 |
AlertCount | Int64 | 报警次数。 |
LastMonthAlertCount | Int64 | 上月报警次数。 |
LastExecuteTime | Int64 | 上次报警时间。 |
NextTriggerTime | Int64 | 下次执行时间。 |
EnableStatus | Boolean | 是否开启。 |
AlertStatus | Boolean | 是否删除。 |
InAck | Boolean | 是否Ackownledge。 |
AckUntilTime | int64 | Ack直到。 |
POST https://open.volcengineapi.com?Action=GetAlertRuleList&Version=2022-07-11 &<公共请求参数>
{ "ResponseMetadata": { "Action": "GetAlertRuleList", "Region": "cn-beijing", "RequestId": "", "Service": "apmplus_server", "Version": "2022-07-11" }, "Result": { "Rules": [ { "Config": { "AlertStrategy": { "AlertLevel": [ "Fatal" ], "AlertSphere": { "IsAgg": false, "ServiceApis": [], "ServiceNames": [ "server_trace_error" ], "SphereType": "service" }, "AlertType": "service", "ExecuteInterval": 120, "GroupAlert": false, "LogicOperator": "and", "MetricConfig": [ { "AlertMetric": { "FormulaMetric": { "AlertSimpleMetric": [ { "Aggregator": "AVG", "Alphabet": "a", "Filters": [ { "Key": "", "Op": "in", "Values": [] } ], "GroupByFields": [], "Ispromql": false, "Metric": "", "MetricCategory": "", "MetricLabel": "", "MetricSource": "", "MetricType": "", "Unit": "" } ], "FormulaQuery": { "Alias": "", "Alphabet": "", "Formula": "", "Hide": false, "Id": "", "Unit": "" } }, "IsFormula": false, "SimpleMetric": { "Aggregator": "AVG", "Alphabet": "a", "Filters": [ { "Key": "", "Op": "in", "Values": [] } ], "GroupByFields": [], "Ispromql": false, "Metric": "apminsight.service.log.error", "MetricCategory": "service", "MetricLabel": "错误日志数", "MetricSource": "influxdb", "MetricType": "", "Unit": "" } }, "CompareConfigList": { "Fatal": { "CompareOp": "\u003e", "CompareType": "threshold", "Level": "Fatal", "Value": 3, "WindowSize": 60 }, "Notice": { "CompareOp": "\u003e", "CompareType": "threshold", "Level": "Notice", "Value": 0, "WindowSize": 60 }, "Warn": { "CompareOp": "\u003e", "CompareType": "threshold", "Level": "Warn", "Value": 0, "WindowSize": 60 } }, "Id": "8979402427-1655877919010", "RollupTimeframeByAggregator": "SUM", "ScanWindow": 5 } ], "NoDataNotify": false, "NoDataNotifyThreshold": 10, "ServiceNames": [ "server_trace_panic" ], "WatchdogEvents": [ { "Category": "host", "CategoryLabel": "主机监控", "EventName": "cpu_used_ratio_overtop", "EventNameLabel": "CPU使用率过高", "Filters": [] } ] }, "Desc": "", "Name": "gyf_test error_log1", "NotifyConfig": { "NotifyGroup": [ 93 ], "NotifyInterval": 86400, "NotifyTypes": [ "email" ] } }, "Id": 241, "Status": { "AckUntilTime": "1655877953", "AlertCount": "12119", "AlertStatus": true, "CreateAt": "1655877953", "CreateBy": { "AvatarUrl": "", "Email": "", "Name": "bytedance-apm" }, "EnableStatus": true, "InAck": false, "LastExecuteTime": "1657801440", "LastMonthAlertCount": "0", "LastTrigerTime": "0", "NextTriggerTime": "1657801560", "UpdateAt": "1657800066", "UpdateBy": { "AvatarUrl": "", "Email": "", "Name": "bytedance-apm" } } } ], "Total": 1 } }