获取告警屏蔽配置规则

最近更新时间: 2026-10-11 00:14:51

1. 接口描述

接口请求域名： cls.api3.fincloud.tencent.com。

获取告警屏蔽配置规则

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

接口更新时间：2025-04-09 15:20:46。

接口既验签名又鉴权。

2. 输入参数

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

参数名称 必选 允许NULL 类型 描述
Action 是 否 String 公共参数，本接口取值：DescribeAlarmShields
Version 是 否 String 公共参数，本接口取值：2020-10-16
Region 是 否 String 公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表
AlarmNoticeId 是 否 String 通知渠道组id。
示例值： notice-57f5808c-4a55-11eb-b378-0242ac130002
Filters 否 否 Array of Filter - taskId:按照【规则id】进行过滤。类型：String 必选：否 - status:按照【规则状态】进行过滤。类型：String。 支持 0:暂未生效，1:生效中，2:已失效。 必选：否 每次请求的Filters的上限为10，Filter.Values的上限为100。
示例值：查看
Offset 否 否 Uint64 分页的偏移量，默认值为0。
示例值： 0
Limit 否 否 Uint64 分页单页限制数目，默认值为20，最大值100。
示例值： 20

3. 输出参数

参数名称 类型 描述
TotalCount Uint64 符合条件的规则总数目
示例值： 5
InvalidCount Uint64 告警屏蔽未生效数量
示例值： 3
ValidCount Uint64 告警屏蔽生效中数量
示例值： 1
ExpireCount Uint64 告警屏蔽已过期数量
示例值： 1
AlarmShields Array of AlarmShieldInfo 告警屏蔽规则详情
示例值：查看
RequestId String 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 错误码

该接口暂无业务逻辑相关的错误码，其他错误码详见公共错误码。

5. 示例

示例1 获取告警屏蔽配置信息

获取告警屏蔽配置信息

输入示例

POST / HTTP/1.1
Host: cls.api3.fincloud.tencent.com
Content-Type: application/json
X-TC-Action: DescribeAlarmShields
<Common Parameters>

{
  "AlarmNoticeId": "notice-ea115e5a-04c4-421e-9ba3-fb177e9025cb",
  "Filters": [
    {
      "Key": "status",
      "Values": [
        "1"
      ]
    }
  ],
  "Offset": 0,
  "Limit": 10
}

输出示例

{
  "Response": {
    "TotalCount": 1,
    "AlarmShields": [
      {
        "AlarmNoticeId": "notice-ea115e5a-04c4-421e-9ba3-fb177e9025cb",
        "TaskId": "ea115e5a-04c4-421e-9ba3-fb177e9025cb",
        "StartTime": 1701933943,
        "EndTime": 1701993943,
        "Type": 1,
        "Rule": "",
        "Reason": "testing",
        "Source": 1,
        "Operator": "1001（user）",
        "Status":1,
        "CreateTime": 1701933943,
        "UpdateTime": 1701933943
      }
    ],
    "RequestId": "11115e5a-04c4-421e-9ba3-fb177e902511"
  }
}