tencent cloud

PrevNext

文档反馈

请输入关键字

Recent Pages

文档
腾讯云可观测平台
    文档
    Download PDF

    告警回调说明

    最后更新时间：2024-04-22 16:35:53
    下载PDF
      通过接口回调，您的企业微信群或自建系统可以直接收到腾讯云可观测平台的告警通知。接口回调具备将告警信息通过 HTTP 的 POST 请求推送到可访问公网 URL 的功能，您可基于接口回调推送的告警信息做进一步的处理。如需通过企业微信群接收告警通知，请参见 配置企业微信群接收告警通知。
      说明：
      当前告警回调没有认证机制，不支持 HTTP 认证。
      告警推送失败最多重试3次，每次推送请求的超时等待时间为5秒。
      当用户创建的告警策略被触发或恢复时，均会通过接口回调推送告警消息。接口回调也支持重复告警。
      腾讯云可观测平台回调 API 出方向 IP 为动态随机分配，无法将具体的 IP 信息提供给您，但 IP 端口固定为80端口，建议您根据80端口在安全组上配置加全放通策略。
      告警回调暂不支持按通知时段推送告警通知，后续会支持，敬请期待。

      操作步骤

      1. 进入 腾讯云可观测平台控制台 > 通知模板。
      2. 单击新建通知模板，进入新建通知模板。
      3. 在新建通知模板页配置完基础信息后，在接口回调模块中填写公网可访问到的 URL 作为回调接口地址（例如域名或IP[:端口][/path]），腾讯云可观测平台将及时把告警信息推送到该地址。
      4. 进入 告警策略列表，单击需要绑定告警回调的策略名称，进入管理告警策略页，并在告警策略页单击通知模板。
      5. 腾讯云可观测平台会将告警消息通过 HTTP 的 POST 请求推送您系统的 URL 地址，您可以参考 告警回调参数说明，对推送的告警信息做进一步的处理。
      
      
      

      告警回调鉴权

      接口回调支持基于 BasicAuth 的用户安全验证。如果您想将告警信息回调发送到需要用户验证的服务时，可以在接口回调 URL 中使用 HTTP 身份验证来实现。例如将https://my.service.example.com 改成 https://<USERNAME>:<PASSWORD>@my.service.example.com。
      
      
      

      告警回调参数说明

      当告警规则被触发时，腾讯云可观测平台会将告警消息发送到您系统的 URL 地址。接口回调通过 HTTP 的 POST 请求发送 JSON 格式的数据，您可以根据下列参数说明对告警信息做进一步的处理。

      指标告警

      指标告警参数示例

      说明：
      大部分指标的 durationTime 和 alarmStatus 数据类型为 string，云服务器的网络类型告警指标的 namespace 为 “qce/lb”。
      {
             "sessionId": "xxxxxxxx",
             "alarmStatus": "1",    // 1为告警，0为恢复
             "alarmType":"metric",    // 告警类型（"metric": 指标告警，"event": 事件告警）
             "alarmObjInfo": {
                  "region": "gz",  // 无地域属性的产品不返回该字段
                  "namespace": "qce/cvm",      // 产品的名字空间
                  "appId": "xxxxxxxxxxxx",
                  "uin": "xxxxxxxxxxxx",
                  "dimensions": {               // dimensions字段里的内容不同产品有差异,请参考下文指标告警 dimensions 示例
                      "unInstanceId": "ins-o9p3rg3m",  
                      "objId":"xxxxxxxxxxxx"
                  }
             },
             "alarmPolicyInfo": {
                      "policyId": "policy-n4exeh88",   // 告警策略组ID
                      "policyType": "cvm_device",     // 告警策略类型名，产品策略类型和维度信息文档中的策略类型英文
                      "policyName": "test",      // 告警策略组名称
                      "policyTypeCName": "云服务器-基础监控",      // 告警策略类型展示名称
                      "conditions": {
                          "metricName": "cpu_usage",         // 指标名称
                          "metricShowName": "CPU 利用率",       // 指标展示名称（中文名）
                          "calcType": ">",              // 比较方式（无阈值的指标不返回该字段）
                          "calcValue": "90",            // 告警阈值（无阈值的指标不返回该字段）
                          "calcUnit": "%",            // 告警阈值单位（无阈值的指标不返回该字段）
                          "currentValue": "100",       // 当前告警值（无阈值的指标不返回该字段）
                          "historyValue": "5",         //历史告警值（无阈值的指标不返回该字段）
                          "unit": "%",                 // 单位（无阈值的指标不返回该字段）
                          "period": "60",              // 统计粒度（单位：s；无阈值的指标不返回该字段）
                          "periodNum": "1",            // 持续周期（无阈值的指标不返回该字段）
                          "alarmNotifyType": "continuousAlarm",    // 是否支持重复告警（"singleAlarm": 不重复告警，"exponentialAlarm": 指数周期告警，"continuousAlarm": 持续告警，无阈值的指标不返回该字段）
                          "alarmNotifyPeriod": 300                 // 重复告警的频率（单位: s；无阈值的指标不返回该字段）
                      }
              },
              "firstOccurTime": "2017-03-09 07:00:00",     // 第一次触发告警的时间
              "durationTime": 500,       // 告警持续时间（单位：s；未恢复时为第一次触发告警后截止到此次发送告警的时间）
              "recoverTime": "2017-03-09 07:50:00"     // 告警恢复时间（单位：s；未恢复时为0；恢复将会显示具体时间，例如：2017-03-09 07:50:00）
      }
      说明：
      如需获取产品策略类型和命名空间，请参见 产品策略类型 和 云产品指标。

      指标告警 dimensions 示例

      云服务器 CVM-基础监控

      "dimensions": {
               "unInstanceId": "ins-aoaaah55", //云服务器实例 ID
               "objId": "94f1133c-46cf-4c61-a4c1-d928183aba47",       // 后台绑定的实例维度
               "objName": "172.21.30.15#588789"       // 告警短信内返回的实例相关信息
      }

      云服务器 CVM-存储监控

      "dimensions": {
               "diskid": "disk-1yukg09l", // 云硬盘ID
               "objId": "disk-1yukg09l",       // 后台绑定的实例维度
               "objName": "disk-1yukg09l(Lstarsqlserverdb-011/ins-i7d3ifpp)"       // 告警短信内返回的实例相关信息
      }

      云数据库 MySQL

      "dimensions": {
               "uInstanceId": "cdb-emzu6ysk",//云数据库实例 ID
               "objId": "d6bc4b82-3acc-11eb-b11e-4cf95dd88ae6",       // 后台绑定的实例维度
               "objName": "cdb-emzu6ysk(实例名:平台发展_xxljob,IP:10.66.234.242:3306)"       // 告警短信内返回的实例相关信息
      }

      云数据库 Redis（1分钟）

      "dimensions": {
               "appid": "1252068037",    //账户APPID
               "instanceid":"crs-1amp2588",  // 云数据库 Redis 实例 ID
               "objId": "crs-af3bcreh",       // 后台绑定的实例维度
               "objName": "ID:crs-1amp2583|Instance Name：price|Ip Port：10.55.182.52:6379"       // 告警短信内返回的实例相关信息
      }

      云数据库 Redis（5s-redis节点）

      "dimensions": {
               "appid": "1252068000",    //账户APPID
               "instanceid":"crs-1amp2588",  // 云数据库 Redis 实例 ID         
               "rnodeid":"0f2ce0f969c4f43bc338bc1d6f60597d654bb3e4" // redis 节点ID
               "objId": "crs-1amp2588##2b6ff049e9845688f5150a9ee7fc8d38cab2222",       // 后台绑定的实例维度 
               "objName": "crs-1amp2588##2b6ff049e9845688f5150a9ee7fc8d38cab2222"       // 告警短信内返回的实例相关信息
      }
      

      云数据库 Redis（5s-实例汇总）

      "dimensions": {
              "AppId": "1252068000",    //账户APPID
              "InstanceId":"crs-1amp2588",  // 云数据库 Redis 实例 ID
              "objId": "crs-1amp288#[instancename]",       // 后台绑定的实例维度
              "objName": "ID:crs-1amp288|Instance Name：price|Ip Port：10.99.182.52:9979"       // 告警短信
              内返回的实例相关信息
      }

      云数据库 Redis（5s-proxy节点）

      "dimensions": {
             "appid": "1252068037",    //账户APPID
             "instanceid":"crs-1amp2583",  // 云数据库 Redis 实例 ID
             "pnodeid":"0f2ce0f969c4f43bc338bc1d6f60597d654bb3e4" // proxy 节点 ID
             "objId": "crs-1amp2588##2b6ff049e9845688f5150a9ee7fc8d38cab222",       // 后台绑定的实例维
           "objName": "crs-1amp2588##2b6ff049e9845688f5150a9ee7fc8d38cab222"       // 告警短信内返回的实例相关信息
      }

      负载均衡-七层协议

      "dimensions": {
               "protocol": "https",    //监听协议
               "vip": "14.22.4.26",  // 负载均衡 vip
               "port": "443",  //后端服务器端口
               "objId": "14.22.4.26#443#https",       // 后台绑定的实例维度
               "objName": "clbtestname | Default-VPC | 18.25.31.161(htps:443) | service:clb, product:monitor"       // 告警历史返回的告警对象相关信息，clbname | networkname | vip(protocol:vport) | tags
      }

      负载均衡-外网监听器

      "dimensions": {
               "protocol": "https",   //监听协议
               "vip": "118.25.31.161",   // 负载均衡 vip
               "vport": 443,  //后端服务器端口
               "objId": "118.25.31.161#443#https",       // 后台绑定的实例维度，vip#vport#protocol
               "objName": "clbtestname | Default-VPC | 18.25.31.161(htps:443) | service:clb, product:monitor"       // 告警历史返回的告警对象相关信息，clbname | networkname | vip(protocol:vport) | tags
      }

      负载均衡-内网监听器

      "dimensions": {
               "protocol": "https",      //监听协议
               "vip": "14.22.4.26",    // 负载均衡 VIP
               "vpcId": vpc-1ywqac83,    //私有网络 ID
               "vport": "443",          //后端服务器端口
               "objId": "14.22.4.26#443#https",       //   后台绑定的实例维度，vip#vport#protocol
               "objName": "clbtestname | Default-VPC | 18.25.31.161(htps:443) | service:clb, product:monitor"       // 告警历史返回的告警对象相关信息，clbname | networkname | vip(protocol:vport) | tags
      }

      负载均衡-服务器端口(传统型内网)

      "dimensions": {
             "protocol": "https",  //监听协议
               "lanIp": "111.222.111.22",
               "port": "440"  //后端服务器端口
               "vip": "14.12.13.25",  //负载均衡 VIP
               "vpcId": vpc-1ywqac83,   //负载均衡所在私有网络 ID
               "loadBalancerPort": "443",   //负载均衡监听端口号
           	 "objId": "14.12.13.25#443#https",       // 后台绑定的实例维度
               "objName": "14.12.13.25#443#https"       // 告警短信内返回的实例相关信息
      }

      云数据库 SQL Server

      "dimensions": {
               "uid": "gamedb.gz18114.cdb.db",    
               "objId": "mssql-nuvazldx(10.88.6.49:1433)",       // 后台绑定的实例维度
               "objName": "gamedb.gz18114.cdb.db"       // 告警短信内返回的实例相关信息
      }

      云数据库 MongoDB

      "dimensions": {
              "target": "cmgo-ajc6okuy",     
              "objId": "cmgo-ajc6okuy",       // 后台绑定的实例维度
              "objName": "cmgo-ajc6okuy(instance name:bigdata_mongodb_大数据,IP:10.1.1.23:27018)"       // 告警短信内返回的实例相关信息
      }

      云数据库 PostgreSQL

      "dimensions":{
           "uid":"2123"
           "objId":"2123",    // 后台绑定的实例维度
           "objName":"ID:postgres-1292ja01|Instance Name：td100-dev-all-pgsql-1|Ip Port：10.80.24.3:5432"  // 告警短信内返回的实例相关信息
      }

      云数据库 CYNOSDB_MYSQL

      "dimensions":{
           "appid":"1256754779",
           "clusterid":"cynosdbmysql-p7ahy11x",
           "instanceid":"cynosdbmysql-inscyi56ruc",
           "insttype":"ro",
           "objId":"1256754779#cynosdbmysql-p7ahy11x#cynosdbmysql-ins-cyi56ruc#ro", // 后台绑定的实例维度
           "objName":"1256754779#cynosdbmysql-p7ahy11x#cynosdbmysql-ins-cyi56ruc#ro" // 告警短信内返回的实例相关信息
      }

      云数据库 TcaplusDB

      "dimensions": {
           "ClusterId":"xxx",
           "TableInstanceId":"xxx",
               "objId": "xxx",       // 后台绑定的实例维度
           "objName": "xxx"       // 告警短信内返回的实例相关信息
      }

      云数据库 TDSQL MySQL-实例汇总

      "dimensions": {
           "InstanceId":"tdsqlshard-jkeqopm0j",
           "objId": "xxx",       // 后台绑定的实例维度
           "objName": "xxx"       // 告警短信内返回的实例相关信息
      }

      云数据库 MariaDB -实例汇总

      "dimensions": {
           "InstanceId":"tdsql-jkeqopm0j"
           "objId": "xxx",       // 后台绑定的实例维度
           "objName": "xxx"       // 告警短信内返回的实例相关信息
          }

      云函数

      "dimensions": {
             "appid": "1251316163",
           "function_name": "insert-tapd-task-result",  //云函数名称
           "namespace": "qmap-insight-core",  // 云函数命名空间
           "version": "$latest" ,    // 云函数版本
              "objId": "1251316163#insert-tapd-task-result#qmap-insight-core#$latest",       // 后台绑定的实例维度
              "objName": "1251316163#insert-tapd-task-result#qmap-insight-core#$latest"       // 告警短信内返回的实例相关信息
      }

      对象存储

      "dimensions": {
               "bucket": "fms-1255817900",       // 存储桶名称
               "objId": "fms-1255817900",       // 后台绑定的实例维度
               "objName": "fms-1255817900"       // 告警短信内返回的实例相关信息
      }

      私有网络-NAT 网关

      "dimensions": {
               "uniq_nat_id": "nat-4d545d",  // NAT 网关ID
               "objId": "nat-4d545d",       // 后台绑定的实例维度
               "objName": "ID: nat-4d545d| Name: 会议接入信安大NAT","uniq_nat_id":"nat-4d545d"     // 告警短信内返回的实例相关信息
      }

      私有网络-VPN 网关

      "dimensions": {
           "appid": "12345",
           "vip": "10.0.0.0",
           "objId": "xxx",       // 后台绑定的实例维度
           "objName": "xxx"       // 告警短信内返回的实例相关信息
      }

      私有网络-VPN 通道

      "dimensions": {
           "vpnconnid": "vpnx-lr6cpqp6",
           "objId": "5642",       // 后台绑定的实例维度
           "objName": "saicm-sit-to-office-td(电信备份)(vpnx-lr6cpqp6)"       // 告警短信内返回的实例相关信息
      }

      私有网络-专线网关

      "dimensions": {
           "directconnectgatewayid": "dcg-8wo1p2ve",
           "objId": "dcg-8wo1p2ve",       // 后台绑定的实例维度
           "objName": "dcg-8wo1p2ve"       // 告警短信内返回的实例相关信息
      }

      私有网络-对等连接

      "dimensions": {
           "peeringconnectionid": "pcx-6gw5wy11",
           "objId": "pcx-6gw5wy11",       // 后台绑定的实例维度
           "objName": "pcx-6gw5wy11"       // 告警短信内返回的实例相关信息
      }

      私有网络-网络探测

      "dimensions":{
           "appid":"1258859999",
           "netdetectid":"netd-591p3g99",
               "objId":"netd-591p3g99",  // 后台绑定的实例维度
           "objName":"ID:netd-591p3g99|名称：check ad-185|描述：",   // 告警短信内返回的实例相关信息
           "vpcid":"vpc-mzfi69pi"
      }

      私有网络-共享带宽包

      "dimensions": {
           "__region__": "xxx",
           "appid": 12345,
           "netgroup": "xxx",
           "objId": "xxx",       // 后台绑定的实例维度
           "objName": "xxx"       // 告警短信内返回的实例相关信息
      }

      内容分发网络 CDN

      "dimensions":{
           "appid":"1257137149",
           "domain":"cloud.tencent.com",
           "objId":"cloud.tencent.com",   // 后台绑定的实例维度
           "objName":"cloud.tencent.com",  // 告警短信内返回的实例相关信息
           "projectid":"1174789"
      }

      消息队列 Ckafka-Topic

      "dimensions":{
           "appid":"1258399706",
           "instance_id":"ckafka-r7f1rrhh",
               "topicid":"topic-cprg5vpp",
           "topicname":"topic-cluebaseserver-qb",
           "objId":"ckafka-r7f1rrhh",    // 后台绑定的实例维度
           "objName":"ckafka-r7f1rrhh"     // 告警短信内返回的实例相关信息
      }

      消息队列 Ckafka-实例

      "dimensions":{
           "appid":"1255817890",
           "instance_id":"ckafka-mdkk0kkk",
           "objId":"ckafka-mdkk0kkk",
           "objName":"ckafka-mdkk0kkk"
      }

      消息队列 Ckafka-ConsumerGroup-Topic

      "dimensions":{
           "appid":"1258344866",
           "consumer_group":"eslog-group22",
           "instance_id":"ckafka-65eago11",
               "topicid":"topic-4q9jjy11",
           "topicname":"eslog"
           "objId":"1258344866#ckafka-65eago11#topic-4q9jjy11#eslog#eslog-group22",
           "objName":"125834866#ckafka-65eago11#topic-4q9jjy11#eslog#eslog-group22",
      }

      消息队列 Ckafka-ConsumerGroup-Partition

      "dimensions":{
           "appid":"1258344866",
           "consumer_group":"eslog-group22",
           "instance_id":"ckafka-65eago11",
               "topicid":"topic-4q9jjy11",
           "topicname":"eslog",
               "partition": "123456",
           "objId":"1258344866#ckafka-65eago11#topic-4q9jjy11#eslog#eslog-group22",
           "objName":"125834866#ckafka-65eago11#topic-4q9jjy11#eslog#eslog-group22",
      }

      文件存储

      "dimensions": {
               "AppId": "1258638990", //账户APPID
               "FileSystemId": "cfs-3e225da4p",     //文件系统id
               "objId": "cfs-3e225da4p",       // 后台绑定的实例维度
               "objName": "cfs-3e225da4p"       // 告警短信内返回的实例相关信息
      }

      专线接入-物理专线

      "dimensions": {
           "directconnectid": "xxx",
           "objId": "xxx",       // 后台绑定的实例维度
           "objName": "xxx"       // 告警短信内返回的实例相关信息
      }

      专线接入-专用通道

      "dimensions": {
           "directconnectconnid": "dcx-jizf8hrr",
           "objId": "dcx-jizf8hrr",       // 后台绑定的实例维度
           "objName": "dcx-jizf8hrr"       // 告警短信内返回的实例相关信息
      }

      容器服务(指标2.0)-容器

      "dimensions": {
           "objId": "xxx",       // 后台绑定的实例维度
           "objName": "xxx",       // 告警短信内返回的实例相关信息
           "region":"xxx"
           "container_id":"xxx",
           "container_name":"xxx",
           "namespace":"xxx",
           "node":"xxx",
           "node_role":"xxx",
           "pod_name":"xxx",
           "tke_cluster_instance_id":"xxx",
           "un_instance_id":"xxx",
           "workload_kind":"xxx",
               "workload_name":"xxx"
          }

      容器服务(指标2.0)-pod

      "dimensions": {
           "objId": "xxx",       // 后台绑定的实例维度
           "objName": "xxx",        // 告警短信内返回的实例相关信息
           "region":"xxx", 
           "namespace":"xxx",
           "node":"xxx",
           "node_role":"xxx",
           "pod_name":"xxx",
           "tke_cluster_instance_id":"xxx",
           "un_instance_id":"xxx",
           "workload_kind":"xxx",
               "workload_name":"xxx"
           }

      容器服务(指标2.0)-工作负载

      "dimensions": {
           "objId": "xxx",       // 后台绑定的实例维度
           "objName": "xxx",        // 告警短信内返回的实例相关信息
           "region":"xxx", 
           "namespace":"xxx",
           "tke_cluster_instance_id":"xxx",
           "workload_kind":"xxx",
               "workload_name":"xxx"
          }

      容器服务(指标2.0)-工作负载

      "dimensions": {
           "objId": "xxx",       // 后台绑定的实例维度
           "objName": "xxx",       // 告警短信内返回的实例相关信息
           "region":"xxx", 
           "namespace":"xxx",
           "tke_cluster_instance_id":"xxx",
           "workload_kind":"xxx",
               "workload_name":"xxx"
          }

      容器服务(指标2.0)-工作负载

      "dimensions": {
           "objId": "xxx",       // 后台绑定的实例维度
           "objName": "xxx",       // 告警短信内返回的实例相关信息
           "region":"xxx", 
           "node":"xxx",
               "node_role":"xxx",
               "pod_name":"xxx",
           "tke_cluster_instance_id":"xxx",
               "un_instance_id":"xxx"
          }

      容器服务(指标2.0)-集群组件

      "dimensions": {
           "objId": "xxx",       // 后台绑定的实例维度
           "objName": "xxx",      // 告警短信内返回的实例相关信息
           "region":"xxx",
           "node":"xxx"
          }

      容器服务(指标2.0)-集群

      "dimensions": {
           "objId": "xxx",       // 后台绑定的实例维度
           "objName": "xxx",       // 告警短信内返回的实例相关信息
           "region":"xxx",
           "tke_cluster_instance_id":"xxx"
          }
      
      联系我们

      联系我们，为您的业务提供专属服务。

      联系我们
      技术支持

      如果你想寻求进一步的帮助，通过工单与我们进行联络。我们提供7x24的工单服务。

      提交工单
      7x24 电话支持
      Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
      隐私条款服务条款缓存条款