1. 接口描述
接口请求域名: config.tencentcloudapi.com 。
更新告警规则
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:UpdateAlarmPolicy。 |
| Version | 是 | String | 公共参数,本接口取值:2022-08-02。 |
| Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
| AlarmPolicyId | 是 | Integer | 告警策略id 示例值:123 |
| Name | 否 | String | 告警策略名 示例值:u544au8b66u89c4u5219 |
| EventScope.N | 否 | Array of Integer | 事件范围 1:当前账号 2:多账号 示例值:[1] |
| RiskLevel.N | 否 | Array of Integer | 风险等级 1:高风险 2:中风险 3:低风险 示例值:[1] |
| NoticeTime | 否 | String | 通知时间段 示例值:09:30:00~23:30:00 |
| NotificationMechanism | 否 | String | 通知机制 示例值:u5b9eu65f6u53d1u9001 |
| Status | 否 | Integer | 状态 1:启用 2:停用 示例值:1 |
| NoticePeriod.N | 否 | Array of Integer | 通知周期,1-7数字分别代表周一到周日 示例值:[1] |
| Description | 否 | String | 策略描述 示例值:u5bf9u4e0du5408u89c4u89c4u5219u8fdbu884cu544au8b66 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 更新告警设置
输入示例
POST / HTTP/1.1
Host: config.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: UpdateAlarmPolicy
<公共请求参数>
{
"AlarmPolicyId": 123,
"Name": "u544au8b66u89c4u5219",
"EventScope": [
1
],
"RiskLevel": [
1
],
"NoticeTime": "09:30:00~23:30:00",
"NotificationMechanism": "u5b9eu65f6u53d1u9001",
"Status": 1,
"NoticePeriod": [
1
],
"Description": "u5bf9u4e0du5408u89c4u89c4u5219u8fdbu884cu544au8b66"
}
输出示例
{
"Response": {
"RequestId": "a7a78dce-732b-4c5e-8cd1-c11ea0e4a40e"
}
}
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
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |