1. 接口描述
接口请求域名： cls.tencentcloudapi.com 。
获取告警屏蔽配置规则
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeAlarmShields。 |
| Version | 是 | String | 公共参数，本接口取值：2020-10-16。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| AlarmNoticeId | 是 | String | 通知渠道组id。 示例值：notice-bb42f112-xxxx-456e-b3c4-ff5472911b42 |
| Filters.N | 否 | Array of Filter | - taskId:按照【规则id】进行过滤。类型：String 必选：否 - status:按照【规则状态】进行过滤。类型：String。 支持 0:暂未生效，1:生效中，2:已失效。 必选：否 每次请求的Filters的上限为10，Filter.Values的上限为100。 |
| Offset | 否 | Integer | 分页的偏移量，默认值为0。 示例值：0 |
| Limit | 否 | Integer | 分页单页限制数目，默认值为20，最大值100。 示例值：20 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TotalCount | Integer | 符合条件的规则总数目 示例值：5 |
| AlarmShields | Array of AlarmShieldInfo | 告警屏蔽规则详情 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取告警屏蔽配置信息
获取告警屏蔽配置信息
输入示例
POST / HTTP/1.1
Host: cls.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeAlarmShields
<公共请求参数>
{
"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": "系统发布，暂时屏蔽",
"Source": 1,
"Operator": "1001（张三）",
"Status": 1,
"CreateTime": 1701933943,
"UpdateTime": 1701933943
}
],
"RequestId": "11115e5a-04c4-421e-9ba3-fb177e902511"
}
}5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| AuthFailure | CAM签名/鉴权错误。 |
| AuthFailure.UnauthorizedOperation | 请求未授权。 |
| FailedOperation | 操作失败。 |
| FailedOperation.Timeout | 操作超时 |
| InternalError | 内部错误。 |
| InternalError.DbError | DB错误。 |
| InternalError.IllegalRole | 角色非法。 |
| InvalidParameter | 参数错误。 |
| InvalidParameter.ParamError | 参数错误。 |
| InvalidParameterValue | 参数取值错误。 |
| LimitExceeded.RecordOutOfLimit | 记录超过限制 |
| MissingParameter | 缺少参数错误。 |
| OperationDenied.AccountNotExists | 账户不存在。 |
| UnauthorizedOperation | 未授权操作。 |
| UnknownParameter | 未知参数错误。 |
| UnsupportedOperation | 操作不支持。 |