创建告警策略
最近更新时间: 2024-10-18 10:38:38
1. 接口描述
接口请求域名： cls.api3.fincloud.tencent.cn。
本接口用于创建告警策略。
默认接口请求频率限制：20次/秒。
接口更新时间：2022-10-31 11:10:35。
接口既验签名又鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数，本接口取值：CreateAlarm |
| Version | 是 | 否 | String | 公共参数，本接口取值：2020-10-16 |
| Region | 是 | 否 | String | 公共参数，详见产品支持的地域列表(TODO) |
| Name | 是 | 否 | String | 告警策略名称 |
| AlarmTargets | 是 | 否 | Array of AlarmTarget | 监控对象列表。 |
| MonitorTime | 是 | 否 | MonitorTime | 监控任务运行时间点。 |
| Condition | 是 | 否 | String | 触发条件。 |
| TriggerCount | 是 | 否 | Int64 | 持续周期。持续满足触发条件TriggerCount个周期后，再进行告警；最小值为1，最大值为10。 |
| AlarmPeriod | 是 | 否 | Int64 | 告警重复的周期。单位是分钟。取值范围是0~1440。 |
| AlarmNoticeIds | 是 | 否 | Array of String | 关联的告警通知模板列表。 |
| Status | 否 | 否 | Bool | 是否开启告警策略。默认值为true |
| Enable | 否 | 否 | Bool | 此参数对外不可见。 是否开启告警策略。默认值为true |
| MessageTemplate | 否 | 否 | String | 用户自定义告警内容 |
| CallBack | 否 | 否 | CallBackInfo | 用户自定义回调 |
| Analysis | 否 | 否 | Array of AnalysisDimensional | 多维分析 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| AlarmId | String | 此参数对外不可见。 告警策略ID。 |
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameter | |
| MissingParameter | |
| InternalError | |
| OperationDenied | |
| ResourceNotFound.TopicNotExist | |
| OperationDenied.ACLFailed | |
| InvalidParameter.AlarmConflict | |
| ResourceNotFound.AlarmNoticeNotExist | |
| OperationDenied.AccountIsolate | |
| OperationDenied.AccountDestroy | |
| OperationDenied.AccountNotExists | |
| OperationDenied.AlarmNotSupportForSearchLow |