1. 接口描述
接口请求域名： cls.api3.fincloud.tencent.cn。
本接口用于创建告警策略。
默认接口请求频率限制：20次/秒。
接口更新时间：2025-08-14 03:00:48。
接口既验签名又鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数，本接口取值：CreateAlarm |
| Version | 是 | 否 | String | 公共参数，本接口取值：2020-10-16 |
| Region | 是 | 否 | String | 公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表 |
| Name | 是 | 否 | String | 告警策略名称 示例值： alarm_name |
| AlarmTargets | 是 | 否 | Array of AlarmTarget | 监控对象列表。 示例值：查看 |
| MonitorTime | 是 | 否 | MonitorTime | 监控任务运行时间点。 示例值：查看 |
| Condition | 是 | 否 | String | 触发条件 注意: Condition和AlarmLevel是一组配置，MultiConditions是另一组配置，2组配置互斥。 示例值： $1.count > 10 |
| TriggerCount | 是 | 否 | Int64 | 持续周期。持续满足触发条件TriggerCount个周期后，再进行告警；最小值为1，最大值为2000。 示例值： 1 |
| AlarmPeriod | 是 | 否 | Int64 | 告警重复的周期。单位是分钟。取值范围是0~1440。 示例值： 0 |
| AlarmNoticeIds | 是 | 否 | Array of String | 关联的告警通知模板列表。 示例值： ["notice-b02af159-f67b-44c3-877c-a55343f874c3"] |
| Status | 否 | 否 | Bool | 是否开启告警策略。默认值为true，true表示开启告警策略，false表示关闭告警策略。 示例值： true |
| Enable | 否 | 否 | Bool | 该参数已废弃，请使用Status参数控制是否开启告警策略。 示例值： true |
| MessageTemplate | 否 | 否 | String | 用户自定义告警内容 示例值： content |
| CallBack | 否 | 否 | CallBackInfo | 用户自定义回调 示例值：查看 |
| Analysis | 否 | 否 | Array of AnalysisDimensional | 多维分析 示例值：查看 |
| GroupTriggerStatus | 否 | 否 | Bool | 分组触发状态。 默认值false 示例值： true |
| GroupTriggerCondition | 否 | 否 | Array of String | 分组触发条件。 示例值： ["$1.conut"] |
| Tags | 否 | 否 | Array of Tag | 标签描述列表，通过指定该参数可以同时绑定标签到相应的告警策略。 最大支持10个标签键值对，并且不能有重复的键值对。 示例值：查看 |
| MonitorObjectType | 否 | 否 | Uint64 | 监控对象类型。0:执行语句共用监控对象; 1:每个执行语句单独选择监控对象。 不填则默认为0。 当值为1时，AlarmTargets元素个数不能超过10个，AlarmTargets中的Number必须是从1开始的连续正整数，不能重复。 示例值： 0 |
| Classifications | 否 | 否 | Array of AlarmClassification | 告警附加分类信息列表。 Classifications元素个数不能超过20个。 Classifications元素的Key不能为空，不能重复，长度不能超过50个字符，符合正则 ^a-z$。 Classifications元素的Value长度不能超过200个字符。 示例值：查看 |
| AlarmLevel | 否 | 否 | Uint64 | 告警级别 0:警告(Warn); 1:提醒(Info); 2:紧急 (Critical)。 注意: 不填则默认为0。 Condition和AlarmLevel是一组配置，MultiConditions是另一组配置，2组配置互斥。 示例值： 0 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| AlarmId | String | 告警策略ID。 示例值： alarm-479dec34-4a59-11eb-b378-0242ac130002 |
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameter | 参数错误。 |
| MissingParameter | 缺少参数错误。 |
| InternalError | 内部错误。 |
| OperationDenied | 操作被拒绝。 |
| ResourceNotFound.TopicNotExist | 日志主题不存在。 |
| OperationDenied.ACLFailed | ACL校验失败。 |
| InvalidParameter.AlarmConflict | 告警策略已经存在。 |
| ResourceNotFound.AlarmNoticeNotExist | 告警策略通知模板不存在。 |
| OperationDenied.AccountIsolate | 账户欠费。 |
| OperationDenied.AccountDestroy | 账户已销毁。 |
| OperationDenied.AccountNotExists | 账户不存在。 |
| OperationDenied.AlarmNotSupportForSearchLow | 低频不支持告警。 |