告警渠道检测接口
最近更新时间: 2024-10-18 10:38:39
1. 接口描述
接口请求域名： cls.api3.fincloud.tencent.cn。
告警渠道检测接口
默认接口请求频率限制：20次/秒。
接口更新时间：2022-10-31 11:10:35。
接口既验签名又鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数，本接口取值：CheckAlarmChannel |
| Version | 是 | 否 | String | 公共参数，本接口取值：2020-10-16 |
| Region | 是 | 否 | String | 公共参数，详见产品支持的地域列表(TODO) |
| NoticeReceivers | 否 | 否 | Array of NoticeReceiver | 告警通知接收者数组 |
| WebCallbacks | 否 | 否 | Array of WebCallback | 回调数组 |
| Type | 是 | 否 | String | 通知类型（Trigger,Recovery,All） |
| Name | 是 | 否 | String | 名称 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| ChannelTestResults | ChannelTestResult | 此参数对外不可见。 测试结果 |
| ErrorCode | Int64 | 此参数对外不可见。 是否成功进行测试 |
| ErrorMessage | String | 此参数对外不可见。 错误原因 |
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameter | |
| MissingParameter | |
| InternalError | |
| OperationDenied | |
| OperationDenied.ACLFailed |