日志服务创建告警策略-API 文档-文档中心-腾讯云

1. 接口描述

接口请求域名： cls.tencentcloudapi.com 。

本接口用于创建告警策略。

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：CreateAlarm。
Version	是	String	公共参数，本接口取值：2020-10-16。
Region	是	String	公共参数，详见产品支持的地域列表。
Name	是	String	告警策略名称示例值：p1-业务告警
AlarmTargets.N	是	Array of AlarmTarget	监控对象列表。
MonitorTime	是	MonitorTime	监控任务运行时间点。
TriggerCount	是	Integer	持续周期。持续满足触发条件TriggerCount个周期后，再进行告警；最小值为1，最大值为2000。示例值：1
AlarmPeriod	是	Integer	告警重复的周期，单位是分钟。取值范围是0~1440。示例值：0
AlarmNoticeIds.N	是	Array of String	关联的告警通知模板列表。示例值：["notice-b02af159-f67b-44c3-877c-a55343f874c3"]
Condition	否	String	触发条件注意: - Condition和AlarmLevel是一组配置，MultiConditions是另一组配置，2组配置互斥。示例值：$1.count > 10
AlarmLevel	否	Integer	告警级别 0:警告(Warn); 1:提醒(Info); 2:紧急 (Critical)。注意: - 不填则默认为0。 - Condition和AlarmLevel是一组配置，MultiConditions是另一组配置，2组配置互斥。示例值：0
MultiConditions.N	否	Array of MultiCondition	多触发条件注意: - Condition和AlarmLevel是一组配置，MultiConditions是另一组配置，2组配置互斥。
Status	否	Boolean	是否开启告警策略。默认值为true 示例值：true
Enable	否	Boolean	该参数已废弃，请使用Status参数控制是否开启告警策略。示例值：true
MessageTemplate	否	String	用户自定义告警内容示例值：{{range .AnalysisResult.sync}}\n\n集群{{.ClusterID}}中节点失败\n\n{{end}}
CallBack	否	CallBackInfo	用户自定义回调
Analysis.N	否	Array of AnalysisDimensional	多维分析
GroupTriggerStatus	否	Boolean	分组触发状态。默认值false 示例值：true
GroupTriggerCondition.N	否	Array of String	分组触发条件。示例值：["$1.conut"]
Tags.N	否	Array of Tag	标签描述列表，通过指定该参数可以同时绑定标签到相应的告警策略。最大支持10个标签键值对，并且不能有重复的键值对。
MonitorObjectType	否	Integer	监控对象类型。0:执行语句共用监控对象; 1:每个执行语句单独选择监控对象。不填则默认为0。当值为1时，AlarmTargets元素个数不能超过10个，AlarmTargets中的Number必须是从1开始的连续正整数，不能重复。示例值：0
Classifications.N	否	Array of AlarmClassification	告警附加分类信息列表。 Classifications元素个数不能超过20个。 Classifications元素的Key不能为空，不能重复，长度不能超过50个字符，符合正则 `^[a-z]([a-z0-9_]{0,49})$`。 Classifications元素的Value长度不能超过200个字符。

3. 输出参数

参数名称	类型	描述
AlarmId	String	告警策略ID。示例值：alarm-479dec34-4a59-11eb-b378-0242ac130002
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 创建告警策略

创建告警策略

输入示例

POST / HTTP/1.1
Host: cls.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateAlarm
<公共请求参数>

{
    "Name": "test-p0 告警策略",
    "AlarmTargets": [
        {
            "Query": "level:error | select count(*) as cnt limit 100",
            "Number": 1,
            "StartTimeOffset": -15,
            "EndTimeOffset": 0,
            "SyntaxRule": 1,
            "LogsetId": "ad5a574c-xxxx-xxxx-bb67-990d0cb9747a",
            "TopicId": "test-cos-1254111111"
        }
    ],
    "MonitorTime": {
        "Type": "Period",
        "Time": 1
    },
    "TriggerCount": 1,
    "AlarmPeriod": 15,
    "AlarmNoticeIds": [
        "notice-1a2c6c17-xxxx-xxxx-81be-25248ada5a4c"
    ],
    "Status": true,
    "MessageTemplate": "{{.Label}}",
    "CallBack": {
        "Headers": [],
        "Body": ""
    },
    "Analysis": [
        {
            "Name": "自定义检索分析",
            "Type": "query",
            "Content": "level:error | select err limit 100",
            "ConfigInfo": [
                {
                    "Key": "SyntaxRule",
                    "Value": "1"
                }
            ]
        }
    ],
    "GroupTriggerStatus": false,
    "GroupTriggerCondition": [],
    "Tags": [],
    "MonitorObjectType": 0,
    "Classifications": [],
    "MultiConditions": [
        {
            "Condition": "[$1.__QUERYCOUNT__]> 10000",
            "AlarmLevel": 0
        }
    ]
}

输出示例

{
    "Response": {
        "AlarmId": "alarm-37cd7e19-xxxx-xxxx-82cc-00713ef449f6",
        "RequestId": "ab6b1233-xxxx-xxxx-91f5-c6fad91966fe"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

Tencent Cloud SDK 3.0 for Python: GitHub Gitee
Tencent Cloud SDK 3.0 for Java: GitHub Gitee
Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
Tencent Cloud SDK 3.0 for Go: GitHub Gitee
Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
Tencent Cloud SDK 3.0 for C++: GitHub Gitee
Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
InternalError	内部错误。
InvalidParameter	参数错误。
InvalidParameter.AlarmConflict	告警策略已经存在。
MissingParameter	缺少参数错误。
OperationDenied	操作被拒绝。
OperationDenied.ACLFailed	ACL校验失败。
OperationDenied.AccountDestroy	账户已销毁。
OperationDenied.AccountIsolate	账户欠费。
OperationDenied.AccountNotExists	账户不存在。
OperationDenied.AlarmNotSupportForSearchLow	低频不支持告警。
ResourceNotFound.AlarmNoticeNotExist	告警策略通知模板不存在。
ResourceNotFound.TopicNotExist	日志主题不存在。