API 文档
文档目录
    加载中
文档中心 API 文档 监控添加

监控添加

1. 接口描述

本接口 Monitor.Create 监控添加。
接口请求地址:https://dnsapi.cn/Monitor.Create
HTTP请求方式:POST

2. 请求参数

以下请求参数列表仅列出了接口请求参数,正式调用时需要加上公共请求参数,见 公共请求参数 页面。

参数名 是否必须 类型 参数描述
domain_id Integer 域名编号。
record_id Integer 记录编号。
port Integer 监控端口,比如80。
monitor_interval Integer 监控间隔(监控频率),支持{60|180|360|600}。
host String 监控主机头,比如 www.dnspod.cn。
monitor_type String 监控类型,支持{http|https|cname|url}。
monitor_path String 监控路径,比如/。
points String 监控节点,用 , 分隔多个,只能选择列表中的节点,并且有数量限制。支持的节点有(ctc: 上海电信, cuc: 深圳联通, ctc-2: 深圳电信, cuc-2: 上海联通, cmc-2: 深圳移动, ctc-3: 成都电信, cuc-4: 天津联通, cmc-4: 天津移动)。
bak_ip String 宕机备用,支持任选选项中的一个。
keep_ttl {yes|no} String 宕机切换后是否修改ttl,默认为 no。
sms_notice String 短信通知,me 域名所有者,share 共享用户,用 , 分隔多选择,比如me,share。
email_notice String 邮件通知,me域名所有者,share共享用户,用,分隔多选择,比如me,share。
less_notice {yes|no} String 是否一个小时内只发一次通知。
callback_url String 回调URL,宕机了会将相关的参数提交到此设置的URL,具体参考回调URL说明。
callback_key String 回调密钥,如果设置了回调URL请设置此参数以保证安全。

说明:

  • 因各套餐各支持的设置参数不同。调用该 API 前,请确保您设置的监控域名支持设置参数。详情参见 DNS 解析套餐
  • 免费版套餐仅支持深圳联通和上海电信两个节点。
  • 免费版套餐的探测频率只能是10分钟一次,付费版最高可以选择1分钟一次。
  • 免费版套餐不支持切换至备份 IP 规则。

bak_ip 选项:

  • pass:只监控,不切换。
  • pause:老版智能暂停功能,详见 D监控切换规则
  • pause2:智能暂停v2, 发现ip宕机后直接暂停该记录,无其它规则。
  • auto:智能切换。
  • 用逗号分隔的IP,设置备用IP。

3. 响应代码

以下请求参数列表仅列出了此接口请求响应代码,除此接口请求响应代码外。还包含 共通返回

响应码 描述
6 域名编号错误。
7 记录编号错误。
8 监控主机头错误。
9 监控端口错误,端口只能是正整数1~65535。
10 监控类型不正确。
11 监控路径不正确。
12 监控间隔不正确。
13 监控节点不正确。
14 监控节点数量超出限制。
15 备用IP不正确。
16 备用url不正确。
17 备用IP不正确。
18 短信设置不正确。
19 邮件设置不正确。
20 此记录已经存在监控。
21 监控数量超出限制。
22 回调URL不正确。

4. 示例

curl -X POST https://dnsapi.cn/Monitor.Create -d 'login_token=LOGIN_TOKEN&format=json&domain_id=2317346&record_id=16909160&port=80&monitor_type=http&monitor_path=/&monitor_interval=360&points=ctc,cuc&bak_ip=pass&host=testapi.com'

返回示例如下:

  • JSON:
{
    "status": {
        "code": "1",
        "message": "Action completed successful",
        "created_at": "2012-11-24 21:25:30"
    },
    "monitor": {
        "monitor_id": "6aac176e-363a-11e2-bab7-0819a6248970",
        "record_id": 16909160
    }
}
最近更新于 2022-01-24 11:47

DNSPod 域名检测工具

查询域名信息,快速排查网站问题

网站自助排障

快速判断问题、提供合适的解决方案