创建告警规则

名称

类型

是否必填

描述

示例值

name

String

是

告警名称，project下唯一。

alert-123456

displayName

String

是

告警显示名称。

test-alert

description

String

否

告警描述。

一条告警规则。

schedule

Dictionary

是

告警调度配置。

{
    "type": "FixedRate",
    "interval": "1m"
}

configuration

Dictionary

是

告警详细配置。

{
    "version": "2.0",
    "type": "default",
    "dashboard": "internal-alert-analysis",
    "queryList": [{
        "storeType": "log",
        "region": "cn-hangzhou",
        "project": "demo-test-project",
        "store": "test-logstore",
        "query": "* | select count(*) cnt",
        "timeSpanType": "Truncated",
        "start": "-1m",
        "end": "absolute",
        "powerSqlMode": "auto"
    }],
    "groupConfiguration": {
        "type": "no_group",
        "fields": []
    },
    "joinConfigurations": [],
    "severityConfigurations": [{
        "severity": 6,
        "evalCondition": {
            "condition": "cnt > 0",
            "countCondition": ""
        }
    }],
    "labels": [{
        "key": "service",
        "value": "nginx"
    }],
    "annotations": [{
        "key": "title",
        "value": "Nginx Status Error"
    }, {
        "key": "desc",
        "value": "Nginx Status Error, count: ${cnt}"
    }],
    "autoAnnotation": True,
    "sendResolved": False,
    "threshold": 1,
    "noDataFire": False,
    "noDataSeverity": 6,
    "policyConfiguration": {
        "alertPolicyId": "sls.builtin.dynamic",
        "actionPolicyId": "test-action-policy",
        "repeatInterval": "1m",
        "useDefault": False
    }
}

名称

类型

是否必填

描述

示例值

type

String

是

告警调度配置类型。支持FixedRate和Cron枚举值。

Cron

cronExpression

String

否

Cron表达式。

0/5 * * * *

runImmediately

bool

否

定时任务是否立即执行。

False

timeZone

String

否

Cron 表达式所在时区，默认为空，表示东八区。

+0800

delay

int

否

定时类任务延迟执行（单位是秒：s）。

4

interval

String

否

固定间隔。

1m

名称

类型

是否必填

描述

示例值

muteUntil

int

否

临时关闭时间。

1698907508

version

String

是

版本。

2.0

type

String

否

告警规则类型。

default

dashboard

String

否

告警绑定的仪表盘ID。

dasnboardExample

threshold

int

是

连续触发阈值。

1

noDataFire

bool

是

是否开启无数据告警。

False

noDataSeverity

int

否

无数据告警严重度。

6

sendResolved

bool

是

是否发送恢复告警。

False

autoAnnotation

bool

是

是否开启自动标注。

False

queryList

List

是

查询语句列表。列表变量说明，请参见AlertQuery。

[{
    "storeType": "log",
    "region": "cn-hangzhou",
    "project": "demo-test-project",
    "store": "test-logstore",
    "query": "* | select count(*) cnt",
    "timeSpanType": "Truncated",
    "start": "-1m",
    "end": "absolute",
    "powerSqlMode": "auto"
}]

annotations

List

否

告警标注。列表变量说明，请参见AlertTag。

[{
    "key": "title",
    "value": "Nginx Status Error"
}, {
    "key": "desc",
    "value": "Nginx Status Error, count: ${cnt}"
}]

labels

List

否

告警标签。列表变量说明，请参见AlertTag。

[{
    "key": "service",
    "value": "nginx"
}]

templateConfiguration

Dictionary

否

告警模板配置。参数说明，请参见TemplateConfiguration。

{
    "id": "sls.app.ack.ip.not_enough",
    "type": "sys",
    "lang": "cn"
}

conditionConfiguration

Dictionary

否

告警触发条件。参数说明，请参见ConditionConfiguration。

{
    "condition": "cnt > 100",
    "countCondition": ""
}

severityConfigurations

List

是

告警严重度配置。列表变量说明，请参见SeverityConfiguration。

[{
    "severity": 6,
    "evalCondition": {
        "condition": "cnt > 0",
        "countCondition": ""
    }
}]

joinConfigurations

List

否

告警查询分析语句集合操作配置。列表变量说明，请参见JoinConfiguration。

[{
    "type": "left_join",
    "condition": "$0.id == $1.id"
}]

groupConfiguration

Dictionary

是

分组评估配置。参数说明，请参见GroupConfiguration。

{
    "type": "no_group",
    "fields": []
}

policyConfiguration

Dictionary

否

SLS通知配置。参数说明，请参见PolicyConfiguration。

{
    "alertPolicyId": "sls.builtin.dynamic",
    "actionPolicyId": "test-action-policy",
    "repeatInterval": "1m",
    "useDefault": False
}

sinkEventStore

Dictionary

否

告警发送给事件库配置。参数说明，请参见SinkEventStoreConfiguration。

{
    "enabled": TRUE,
    "endpoint": "cn-shanghai-intranet.log.aliyuncs.com",
    "project": "exampleProject",
    "eventStore": "exampleStore",
    "roleArn": "acs:ram::123456789:role/aliyunlogetlrole"
}

sinkCms

Dictionary

否

告警发送给云监控事件中心配置。参数说明，请参见SinkCmsConfiguration。

{
    "enabled": True
}

sinkAlerthub

Dictionary

否

告警发送给告警管理服务配置。参数说明，请参见SinkAlerthubConfiguration。

{
    "enabled": True
}

tags

List

否

告警自定义标签。

["host"]