操作指南

API 文档

云产品监控指标

更新报警规则

最近更新时间:2022-06-14 06:14:38

我的收藏

1. 接口描述

接口请求域名: monitor.tencentcloudapi.com 。

更新 Prometheus 的报警规则。

请注意,告警对象和告警消息是 Prometheus Rule Annotations 的特殊字段,需要通过 annotations 来传递,对应的 Key 分别为summary/description,,请参考 Prometheus Rule更多配置请参考

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:UpdateAlertRule。
Version String 公共参数,本接口取值:2018-07-24。
Region String 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-beijing, ap-chengdu, ap-chongqing, ap-guangzhou, ap-hongkong, ap-mumbai, ap-nanjing, ap-shanghai, ap-shanghai-fsi, ap-shenzhen-fsi, ap-singapore, ap-tokyo, eu-frankfurt, eu-moscow, na-ashburn, na-siliconvalley, sa-saopaulo
RuleId String Prometheus 报警规则 ID
InstanceId String Prometheus 实例 ID
RuleState Integer 规则状态码,取值如下:
  • 1=RuleDeleted
  • 2=RuleEnabled
  • 3=RuleDisabled

  • 默认状态码为 2 启用。
    RuleName String 报警规则名称
    Expr String 报警规则表达式
    Duration String 报警规则持续时间
    Receivers.N Array of String 报警规则接收组列表
    Labels.N Array of PrometheusRuleKV 报警规则标签列表
    Annotations.N Array of PrometheusRuleKV 报警规则注释列表。

    告警对象和告警消息是 Prometheus Rule Annotations 的特殊字段,需要通过 annotations 来传递,对应的 Key 分别为summary/description。
    Type String 报警策略模板分类

    3. 输出参数

    参数名称 类型 描述
    RuleId String 规则 ID
    RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 更新报警规则

    输入示例

    https://monitor.tencentcloudapi.com/?Action=UpdateAlertRule
    &InstanceId=my-prom-gg
    &RuleId=arule-omq28fcm
    &RuleState=2
    &RuleName=exampleName
    &Expr=job:request_latency_seconds:mean5m{job=\"myjob\"}>0.5
    &Duration=1m
    &Receivers.0=33432
    &<公共请求参数>

    输出示例

    {
      "Response": {
        "RequestId": "qyh38g1ium4-41o5k994o7hcxuq96zab",
        "RuleId": "arule-omq28fcm"
      }
    }

    5. 开发者资源

    腾讯云 API 平台

    腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

    API Inspector

    用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

    SDK

    云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

    命令行工具

    6. 错误码

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

    错误码 描述
    AuthFailure CAM签名/鉴权错误。
    FailedOperation 操作失败。
    FailedOperation.BadYamlFormat Yaml 格式不正确。
    FailedOperation.DbQueryFailed 数据库查询失败。
    FailedOperation.DbRecordCreateFailed 创建数据库记录失败。
    FailedOperation.DbRecordDeleteFailed 数据库记录删除失败。
    FailedOperation.DbRecordUpdateFailed 数据库记录更新失败。
    FailedOperation.GenerateInstanceIDFailed 生成资源ID错误。
    FailedOperation.ResourceExist 资源已经存在。
    FailedOperation.ResourceNotFound 资源不存在。
    InternalError 内部错误。
    InvalidParameter 参数错误。
    目录