1. 接口描述
接口请求域名: monitor.tencentcloudapi.com 。
创建Prometheus告警规则分组
告警分组中可包含多条告警规则,分组内告警消息通过告警分组的通知模板发送。
支持单个告警分组下分别创建启用/禁用的告警规则。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:CreatePrometheusAlertGroup。 |
Version | 是 | String | 公共参数,本接口取值:2018-07-24。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
InstanceId | 否 | String | prometheus实例ID 示例值:prom-23sadu23 |
GroupName | 否 | String | 告警分组名称,不能与其他告警分组重名 示例值:告警规则创建测试 |
GroupState | 否 | Integer | 告警分组状态: 2 -- 启用 3 -- 禁用 不为空时会覆盖 Rules 字段下所有告警规则状态示例值:2 |
AMPReceivers.N | 否 | Array of String | 云监控告警通知模板ID列表,形如Consumer-xxxx或notice-xxxx 示例值:["Consumer-5sfs3242", "notice-as6512as"] |
CustomReceiver | 否 | PrometheusAlertCustomReceiver | 自定义告警通知模板 |
RepeatInterval | 否 | String | 告警通知周期(收敛时间),为空默认1h 示例值:5m |
Rules.N | 否 | Array of PrometheusAlertGroupRuleSet | 要创建的告警规则列表 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
GroupId | String | 创建的告警分组ID,满足正则表达式alert-[a-z0-9]{8} 示例值:alert-sx123a23 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 使用通知模板创建告警规则
使用通知模板创建告警规则
输入示例
POST / HTTP/1.1
Host: monitor.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreatePrometheusAlertGroup
<公共请求参数>
{
"InstanceId": "prom-7vp71mk0",
"GroupName": "创建告警分组测试",
"AMPReceivers": [
"notice-xxxxxx"
],
"Rules": [
{
"RuleName": "规则-1",
"Labels": [
{
"Key": "k1",
"Value": "v1"
}
],
"Annotations": [
{
"Key": "summary",
"Value": "{{$value}}"
},
{
"Key": "describe",
"Value": "规则1告警"
}
],
"Expr": "expr1"
}
]
}
输出示例
{
"Response": {
"GroupId": "alert-2zvqof1a",
"RequestId": "02c92b99-abc9-431b-8b08-42b9977d51cf"
}
}
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 | 操作失败。 |
FailedOperation.BadYamlFormat | Yaml 格式不正确。 |
FailedOperation.DbQueryFailed | 数据库查询失败。 |
FailedOperation.DbRecordCreateFailed | 创建数据库记录失败。 |
FailedOperation.DbRecordDeleteFailed | 数据库记录删除失败。 |
FailedOperation.DbRecordUpdateFailed | 数据库记录更新失败。 |
FailedOperation.GenerateInstanceIDFailed | 生成资源ID错误。 |
FailedOperation.ResourceExist | 资源已经存在。 |
FailedOperation.ResourceNotFound | 资源不存在。 |
InternalError | 内部错误。 |
InvalidParameter | 参数错误。 |