配置审计新建告警

1. 接口描述

接口请求域名： config.tencentcloudapi.com 。

新增告警监控规则

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

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：AddAlarmPolicy。
Version	是	String	公共参数，本接口取值：2022-08-02。
Region	是	String	公共参数，详见产品支持的地域列表。
Name	是	String	告警策略名示例值：规则告警
Type	是	Integer	事件类型 1：资源不合规事件示例值：1
EventScope.N	是	Array of Integer	事件范围 1：当前账号 2：多账号示例值：[1]
RiskLevel.N	是	Array of Integer	风险等级 1：高风险 2：中风险 3：低风险示例值：[1]
NoticeTime	是	String	通知时间段示例值：00:00:00~12:12:12
NotificationMechanism	是	String	通知机制示例值：实时发送
Status	是	Integer	状态 1：启用 2：停用示例值：1
NoticePeriod.N	是	Array of Integer	通知周期示例值：[1]
Description	否	String	策略描述示例值：告警描述

3. 输出参数

参数名称	类型	描述
AlarmPolicyId	Integer	告警策略唯一id 注意：此字段可能返回 null，表示取不到有效值。示例值：1
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 创建告警

输入示例

POST / HTTP/1.1
Host: config.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: AddAlarmPolicy
<公共请求参数>

{
    "Name": "告警规则1",
    "Type": 1,
    "EventScope": [
        1
    ],
    "RiskLevel": [
        1
    ],
    "NoticeTime": "09:30:00~23:30:00",
    "NotificationMechanism": "实时发送",
    "Status": 1,
    "NoticePeriod": [
        1
    ]
}

输出示例

{
    "Response": {
        "AlarmPolicyId": 2,
        "RequestId": "e2c458f6-dedc-46eb-955a-6d2c3555c597"
    }
}

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: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
InvalidParameter	参数错误。
LimitExceeded.AlertPolicyLimit	告警策略数量上限
ResourceNotFound.ResourceTypeNotExist	资源类型不存在。

新建告警

本页目录：