1. 接口描述
接口请求域名: monitor.tencentcloudapi.com 。
创建 Prometheus 告警规则。
请注意,告警对象和告警消息是 Prometheus Rule Annotations 的特殊字段,需要通过 annotations 来传递,对应的 Key 分别为summary/description,,请参考 Prometheus Rule更多配置请参考。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:CreateAlertRule。 |
Version | 是 | String | 公共参数,本接口取值:2018-07-24。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
InstanceId | 是 | String | Prometheus 实例 ID,例如:prom-abcd1234 示例值:prom-123131 |
RuleName | 是 | String | 规则名称 示例值:告警规则测试 |
Expr | 是 | String | 规则表达式,可参考告警规则说明 示例值:job:request_latency_seconds:mean5m{job="myjob"} > 0.5 |
Receivers.N | 是 | Array of String | 告警通知模板 ID 列表 示例值:["Consumer-5sfs3242"] |
RuleState | 否 | Integer | 规则状态码,取值如下: 示例值:2 |
Duration | 否 | String | 规则报警持续时间 示例值:5m |
Labels.N | 否 | Array of PrometheusRuleKV | 标签列表 示例值:[{Key: "ip" Value: "1.1.1.1"}] |
Annotations.N | 否 | Array of PrometheusRuleKV | 注释列表。 告警对象和告警消息是 Prometheus Rule Annotations 的特殊字段,需要通过 annotations 来传递,对应的 Key 分别为summary/description。 示例值:[{Key: "summary" Value: "规则名称"}] |
Type | 否 | String | 报警策略模板分类 示例值:TargetDown |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
RuleId | String | 规则 ID 注意:此字段可能返回 null,表示取不到有效值。 示例值:arule-f2vx2owo |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 创建报警规则
输入示例
POST / HTTP/1.1
Host: monitor.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateAlertRule
<公共请求参数>
{
"Receivers": [
"34224"
],
"InstanceId": "prom-abcd1234",
"Expr": "\"up{service=\\\"rig-prometheus-agent\\\"}>0\"",
"Duration": "5m",
"RuleName": "test",
"RuleState": 2
}
输出示例
{
"Response": {
"RequestId": "hfd437lxxdj3455-qxdb3eyydvw4doxm",
"RuleId": "arule-f2vx2owo"
}
}
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 | 参数错误。 |