Archives 十月 2019

多端监控API使用说明

米发多端监控提供API来新增、修改、删除和查询监控。

在集成API前,请务必阅读 米发API地址及公共参数

获取单个监控项目信息

主动查询指定监控ID监控状态,适用于已存在监控项目,主动查询URL的状态。

请求:GET /monitor/{id}

参数:不需要

接口返回字段:

{
     "data": {
         "id": 监控项目ID,
         "host": 同步的域名转发记录(如果有),
         "monitoring_name": 监控项目名称,
         "urls": 监控的URL列表,数组[],
         "urls_valid": 当前可用的URL列表,数组[],
         "urls_invalid": 当前不可用的URL列表,数组[],
         "urls_invalid_on_monitors": 各个监控模块的不可用URL列表,
         "monitoring_urls_amount_in_healthy": 健康时监控的URL数量,
         "monitoring_config": 监控的配置,
         "notify_config": 告警配置,
         "enabled": 是否启用,
         "next_run_times": 各个模块的下次派发任务时间,
         "extra": 额外信息,
         "create_time": 监控项目创建时间,
         "update_time": 监控项目更新时间
     }
 }

返回示例:

{
    "data": {
        "id": "0ef4c572-40c9-482c-92d2-3cb3cc067523",
        "host": "jiankong.test.mfpad.com",
        "monitoring_name": "jiankong.test.mfpad.com",
        "urls": [
            "http://www.gc788.com/i1",
            "http://www.gc788.com/i2",
            "http://www.gc788.com/i5"
        ],
        "urls_valid": [
            "http://www.gc788.com/i1",
            "http://www.gc788.com/i2",
            "http://www.gc788.com/i5"
        ],
        "urls_invalid": [
            "https://page.mfpad.com/"
        ],
        "urls_invalid_on_monitors": {
            "CnHttpMonitor": [],
            "GlobalHttpMonitor": [
                "https://page.mfpad.com/"
            ]
        },
        "monitoring_urls_amount_in_healthy": 3,
        "monitoring_config": {
            "interval": 3,
            "monitoring_name": "",
            "monitoring_urls": 1,
            "monitors": [
                "CnHttpMonitor",
                "GlobalHttpMonitor"
            ],
            "CnHttpMonitor": {
                "timeout": 5500,
                "interval": 0
            },
            "GlobalHttpMonitor": {
                "timeout": 9000,
                "interval": 0
            }
        },
        "notify_config": {
            "api": {
                "endpoint": ""
            }
        },
        "enabled": 1,
        "next_run_times": {
            "CnHttpMonitor": "2019-10-15 05:02:57",
            "GlobalHttpMonitor": "2019-10-15 05:02:27"
        },
        "extra": {
            "monitoring_urls_added_by_this_request": [],
            "monitoring_urls_deleted_by_this_request": []
        },
        "create_time": "2019-10-06 01:52:32",
        "update_time": "2019-10-15 15:48:15"
    }
}

查询获取所有监控列表及状态

请求: GET /monitor 

返回字段:

{
    "data": [
        {
             单个监控项目字段(详见上方监控信息字段)
        },
        {
             单个监控项目字段(详见上方监控信息字段)
        },
         ......
    ],
    "meta": {
        "pagination": 分页信息
    }
}

查询并更新

主动查询指定监控ID监控状态并更新监控URL列表,适用于已存在监控项目,主动轮询查询URL的状态,如果提供的URL列表与系统中监控不一致,则自动更新系统,新的URL将在更新后被监控。

请求:POST /monitor/{id}/checkAndUpdate

参数:url_list[] URL列表数组,url格式:http(s)://www.abc.com/

返回示例:

{
    "data": {
        字段均与上面监控项目字段相同,其中额外信息会有不同
        "extra": {
            "monitoring_urls_added_by_this_request": 当前请求新增的监控URL列表,
            "monitoring_urls_deleted_by_this_request": 当前请求删除的监控URL列表,
        }
    }
}

修改

修改一个监控项目

请求:PUT /monitor/{id}

参数:可参考上方获取单个监控项目信息中的所有字段

返回:监控项目信息


多端监控API回调通知使用说明

米发多端监控提供URL告警与恢复事件API回调通知,在监控URL发生失效或恢复时,可以收到来自米发的POST通知。

请求类型:POST

请求地址:监控项目设置的API回调地址

回调POST字段内容:

     "monitor_id": 监控项目ID,
     "url": 告警URL,
     "heartbeat": 当前心跳,up为可用,down为失效,
     "monitor_module_name": 报警模块内部名称,
     "occur_time": 发生时间 ISO-8601 格式 (如: 2019-10-10T06:00:00Z) 
     "occur_time_CN": 发生日期及时间,时区 Asia/Shanghai,如2019-10-10 12:10:00
     "reason": 简要原因,
     "monitoring_task": 监控项目信息(与监控查询接口返回一致,可参考多端监控API说明)

回调POST内容示例:

{
     "monitor_id": "0256fd2c-4875-4423-b2f0-93ba4e4f49ae",
     "url": "http://www.gc788.com/is",
     "heartbeat": "down",
     "monitor_module_name": "CnHttpMonitor",
     "occur_time":"2019-10-21T10:01:35Z",
     "occur_time_CN":"2019-10-21 18:01:35","
     "reason": "(56)Failure when receiving data from the peer",
     "monitoring_task": {
         "id": "0256fd2c-4875-4423-b2f0-93ba4e4f49ae",
         "host": "overseas.test.mfpad.com",
         "monitoring_name": "overseas.test.mfpad.com",
         "urls": [
             "http://www.mfpad.com/",
             "http://www.gc788.com/is",
             "https://www.facebook.com/",
             "https://www.google.com/"
         ],
         "urls_valid": [
             "http://www.mfpad.com/"
         ],
         "urls_invalid": [
             "http://www.gc788.com/is",
             "https://www.facebook.com/",
             "https://www.google.com/"
         ],
         "urls_invalid_on_monitors": {
             "WeChatMonitor": [
                 "http://www.gc788.com/is"
             ],
             "CnHttpMonitor": [
                 "https://www.facebook.com/",
                 "https://www.google.com/",
                 "http://www.gc788.com/is"
             ],
             "GlobalHttpMonitor": [
                 "http://www.newdomain1.com/",
                 "http://www.newdomain5.com/",
                 "http://www.gc788.com/now"
             ]
         },
         "monitoring_urls_amount_in_healthy": "4",
         "monitoring_config": {
             "interval": "1",
             "monitoring_name": "",
             "monitoring_urls": "1",
             "monitors": [
                 "WeChatMonitor",
                 "QQMonitor",
                 "CnHttpMonitor"
             ],
             "CnHttpMonitor": {
                 "interval": "0",
                 "timeout": "5000"
             },
             "GlobalHttpMonitor": {
                 "interval": "0",
                 "timeout": "1000"
             }
         },
         "notify_config": {
             "api": {
                 "endpoint": "https://www.mfpad.com/service/record_post"
             }
         },
         "enabled": "1",
         "next_run_times": {
             "WeChatMonitor": "2019-10-15 16:42:37",
             "CnHttpMonitor": "2019-10-15 16:43:37"
         },
         "create_time": "2019-10-06 19:06:46",
         "update_time": "2019-10-15 16:40:18"
     },
     "debug": {}
 }

米发API接口公共参数

本文介绍域名转发、多端监控的API接口公共参数,及接口返回通用格式。

API接口基础地址

https://www.mfpad.com/api/v2

米发控制台中涉及的所有API功能均基于此基础地址

API头部参数

Accept:application/json
Authorization:Bearer {{token}}
Accept-Language:{{lang}}

其中,

{{token}} 是基于 oAuth 2.0 的访问 Token,申请地址:控制台->用户中心->安全中心->API授权管理

{{lang}} 是API返回消息的语言,可选值 zh 和 en

API请求规范

请求米发API需遵循RESTful API 规范,基于URL定位资源,用HTTP动词(GET,POST,DELETE,PUSH等)描述操作,具体可以参考具体接口的文档描述。

API返回规范

米发API返回内容符合RESTful 规范,使用HTTP状态码表示请求成功与失败,具体可以参考具体接口的文档描述。


链接被恶意举报?试试最新的微信防封技术。

辛辛苦苦花的广告费,却被同行恶意举报,损失惨重!

今天这篇文章介绍米发最新的几项技术来有效对抗恶意用户的举报,让您的广告价值再次提升。

1、米发URL列表转发+URL监控

米发的URL列表转发可以实现添加多条URL记录,按照设置进行多种类型的转发,比如:按照列表顺序分散流量,或者说随机分配,配合URL监控可以实现自动禁用失效的URL地址,始终将流量分配到有效的URL。

URL列表转发及URL监控配置示例

2、真人鉴权访问

米发的真人鉴权访问可以有效过滤机器人的流量,其中包括各类搜索引擎、蜘蛛等等。我们会给每一位真实的访问颁发访问鉴权令牌,只有带着令牌的访客才可以查看到你的受保护的内容。

3、泛域名转发+随机分配二级域名

米发有着多达9年的丰富的域名转发行业经验,在全球分布多组域名转发节点,在中国也分布多组优质节点,稳定的服务构架、超强的容灾配置,保证服务的持续性和稳定性。

查看了解更多-> 米发URL转发网址监控