1. 接口描述
接口请求域名： dbbrain.tencentcloudapi.com 。
修改告警策略
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：ModifyAlarmPolicy。 |
| Version | 是 | String | 公共参数，本接口取值：2021-05-27。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| ApplyType | 是 | String | 类型 示例值：instance |
| Enable | 是 | Integer | 开启策略 示例值：1 |
| InstanceIds.N | 是 | Array of InstanceID | 列表 示例值：[{InstanceId: "cdb-k9p7z9l9"}] |
| NewProfileLevel | 是 | String | User-动态关联该用户所有实例 Instance-关联实例列表的实例 示例值：Instance |
| NewProfileName | 是 | String | 新策略名 示例值：test |
| ProfileName | 是 | String | 旧策略名 示例值：test |
| ProfileType | 是 | String | 策略类型 示例值：alarm_policy |
| Remark | 是 | String | 备注 示例值：空 |
| RuleType | 是 | Integer | 规则类型 0-快速，1-自定义 若值为0，则QuickRule不能为空，若值为1，则Rules 不能为空 示例值：0 |
| TemplateInfo.N | 是 | Array of TemplateInfo | 接受模板 |
| QuickRule | 否 | String | 快速规则 支持包括fatal-致命, critical-严重, warning-告警, information-通知 示例值：fatal |
| Rules.N | 否 | Array of AlarmsRules | 自定义规则 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 增加实例
修改策略
输入示例
POST / HTTP/1.1
Host: dbbrain.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyAlarmPolicy
<公共请求参数>
{
"ApplyType": "instance",
"Enable": 1,
"InstanceIds": [
{
"InstanceId": "cdb-k9p7oscf"
},
{
"InstanceId": "cdb-5jqzedc"
}
],
"NewProfileLevel": "Instance",
"NewProfileName": "test",
"ProfileName": "test",
"ProfileType": "alarm_policy",
"Remark": "test",
"RuleType": 0,
"QuickRule": "fatal",
"TemplateInfo": [
{
"TemplateId": "23002",
"TemplateName": "ada测试"
}
]
}输出示例
{
"Response": {
"RequestId": "08baa278-1104-4d3a-8585-027cc511d300"
}
}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签名/鉴权错误。 |
| FailedOperation | 操作失败。 |
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameterValue | 参数取值错误。 |
| MissingParameter | 缺少参数错误。 |
| OperationDenied | 操作被拒绝。 |
| OperationDenied.UserHasNoStrategy | CAM鉴权错误。 |
| RequestLimitExceeded | 请求的次数超过了频率限制。 |
| UnauthorizedOperation | 未授权操作。 |
| UnknownParameter | 未知参数错误。 |