全部文档
当前文档

暂无内容

如果没有找到您期望的内容,请尝试其他搜索词

文档中心

回调接口

最近更新时间:2022-03-01 10:20:46

回调接口

通过回调接口,您的系统可以直接收到金山云的告警通知。回调接口具备将告警信息通过 HTTP 的 POST 请求推送到可访问公网 URL 的功能,您可基于回调接口推送的告警信息做进一步的处理。

回调接口使用方法

  • 回调接口:用户需要提供能接收 HTTP POST 请求的,公网可访问的 url 地址,作为回调地址。

  • 回调触发:触发逻辑与告警短信、邮件一致,当用户创建的告警策略被触发、告警策略恢复时,均会通过回调接口发送告警消息。

  • 绑定回调接口:用户可在创建告警策略第三步:配置回调接口,一个告警策略组至多可绑定五个告警回调 url。

回调接口参数说明

回调接口通过 HTTP 的 POST 请求发送 JSON 格式的数据,参数如下:

{
    "alarmState": 1,    // 1为告警,0为恢复
    "alarmType": "metric", // event为事件告警,metric为阈值告警
    "alarmObjInfo": {
        "region": "华东1(上海)",              // 机房
        "namespace": "Eip",                     // 产品类型
        "tag": [                                //实例id
            "host=50fa05d9211b478293744280ac1592ag" ,
	    "hostName=xxxx"            //实例名称
	    "ipAddr=xxxx"              //实例信息
            "p1=cpu1"
        ]  
    },
    "alarmPolicyInfo": {
        "policyId": 8888,                   // 策略id
        "policyName": "test11",             // 策略名称
        "conditions": [{                    // 策略规则
            "metricAlias": "CPU利用率",        // 指标中文名
            "metricName": "cpu.util",       // 指标英文名
            "period": "5m",                 // 统计周期
            "function": "avg",              // 操作函数max,min,avg,happen
            "points": "1",              // 连续周期
            "op": ">",                  // 比较操作符:>, <
            "threshold": "50",          // 阈值
            "CurValue": "60",           // 当前告警值
            "units": "",                // 单位
            "alarmInterval": "60",           // 告警间隔
            "alarmMax": "3",            // 最大发送告警次数
        }]
    },
    "timestamp": "1547092067",          // 告警时间,从1970年1月1日开始所经过的秒数
    "step": 1                       // 告警次数
"UserId":2000090561		//账号ID
}

事件回调接口参数说明

{
    "alarmState": 1,    // 1为告警,0为恢复
    "alarmType": "event", // event为事件告警,metric为阈值告警
    "alarmObjInfo":{
        "region":"华东1(上海)",    // 机房
        "namespace":"KEC",         // 产品类型
        "tag":[
            "groupid=1e8375da-b0c3-4678-b7bd-313c561fb4cb"    // 事件分组id
            "host=b8709897-1380-441c-a28b-3673350aa25f",      // 实例id
            "hostName=test",       // 实例名称
            "ipAddr=10.0.4.182"    // 实例信息
        ]
    },
    "alarmPolicyInfo":{
        "policyId":6,              // 策略id
        "policyName":"Test_SysEvent_Rule_05",    // 策略名称
        "conditions":[
            {
                "historyId":354616,                 // 告警id
                "eventType":"StatusNotification",   // 事件类型
                "eventName":"Disk:DiskOperationCompleted",   // 事件名称
                "eventTitle":"磁盘操作完成",         // 事件名称
                "eventStatus":"Normal",             // 事件状态
                "eventLevel":"Info",                // 事件等级
                "content":"zzzzzMaintenance.PerformanceImpact[xxx] 3"  // 事件详情
            }
        ]
    },
    "timestamp":1634304898000,   // 告警时间,从1970年1月1日开始所经过的毫秒数
    "step":0,                    // 告警次数
    "userId":73408594            // 账号ID
}
文档导读
纯净模式常规模式

纯净模式

点击可全屏预览文档内容
文档反馈