1. 接口描述
接口请求域名： cls.api3.fincloud.tencent.cn。
本接口用于获取告警策略。
默认接口请求频率限制：20次/秒。
接口更新时间：2025-07-31 01:59:40。
接口只验签名不鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数，本接口取值：DescribeAlarms |
| Version | 是 | 否 | String | 公共参数，本接口取值：2020-10-16 |
| Region | 是 | 否 | String | 公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表 |
| Filters | 否 | 否 | Array of Filter | name 按照【告警策略名称】进行过滤。 类型：String 必选：否 alarmId 按照【告警策略ID】进行过滤。 类型：String 必选：否 topicId 按照【监控对象的日志主题ID】进行过滤。 类型：String 必选：否 enable 按照【启用状态】进行过滤。 类型：String 备注：enable参数值范围: 1, t, T, TRUE, true, True, 0, f, F, FALSE, false, False。 其它值将返回参数错误信息. 必选：否 每次请求的Filters的上限为10，Filter.Values的上限为5。 示例值：查看 |
| Offset | 否 | 否 | Int64 | 分页的偏移量，默认值为0。 示例值： 1 |
| Limit | 否 | 否 | Int64 | 分页单页限制数目，默认值为20，最大值100。 示例值： 1 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Alarms | Array of AlarmInfo | 告警策略列表。 示例值：查看 |
| TotalCount | Int64 | 符合查询条件的告警策略数目。 示例值： 0 |
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| OperationDenied | 操作被拒绝。 |
| OperationDenied.AccountIsolate | 账户欠费。 |
| OperationDenied.AccountDestroy | 账户已销毁。 |
| OperationDenied.AccountNotExists | 账户不存在。 |