Home » 功能 » API

使用 Dotcom-Monitor API 自动化您的监控的每一部分

通过带有文档的REST Web API和XML报告服务(XRS),程序化创建监控器,管理设备和任务,协调负载测试,并将实时性能数据流传输到您自己的仪表板、SIEM和CI/CD管道。
Three floating dark-mode cards on a deep navy background — a Web API JSON request creating a new HTTPS monitor, an XRS XML response with a timing breakdown, and a live API-surface KPI panel showing requests, devices, locations, sessions, and last deploy.
10,000+

全球组织

99.99%

平台正常运行时间服务水平协议

30+

全球监控地点

自1998年起

网站监控领导者

程序化监控

什么是 Dotcom-Monitor API?

Dotcom-Monitor 平台完全可脚本化。您在网页界面中能做的任何操作——从创建新的 HTTP 监控器到提取三个月的性能报告——都可以通过两个互补的服务以编程方式完成:用于配置的基于 REST 的 Web API和用于实时数据提取的XML 报告服务(XRS)

Web API 是一个结构化的基于 JSON 的 HTTP 接口,向您的系统暴露监控和负载测试操作。使用它可以在每次部署时配置新监控器,将数千台设备置于代码即配置管理之下,将监控集成到现有工单工具中,或将实时性能数据嵌入客户面向的状态页面。

XML 报告服务(XRS) 是一个免费的按需数据馈送服务,返回监控结果的 XML 文档。指向任何报告仪表板、BI 工具、Excel 工作簿或内部数据库,以构建自定义视图,无需等待工程支持。

它们共同赋予您的平台、SRE 和 DevOps 团队完全的程序化控制——无需点击 UI。

Web API —— 快速参考

https://api.dotcom-monitor.com/config_api_v1/

格式

JSON 请求 / JSON 响应

方法

GET(读取)· POST / PUT(写入 / 更新)

身份验证

每次请求,60 秒会话;可选 IP 白名单

传输

HTTP 或 HTTPS

XRS —— 快速参考

https://xmlreporter.dotcom-monitor.com/reporting/xml/

格式

通过 HTTP(S) GET 返回 XML 响应

身份验证

在 管理 > 集成 中生成的账户 UID (PID)

数据深度

原始响应最长可达6个月

费用

免费,包含在每个账户中

1

生成密钥

在您的账户中创建 Web API 或 XML Feed 集成。

2

配置

POST JSON 以创建设备、任务、分组、日程和警报。
3

监控

运行程序每天从30多个全球地点按您定义的时间表执行。
4

提取

通过 XRS 将结果拉取到仪表盘、BI、Excel 或内部应用中。
核心 API 功能

UI 所能做的一切 — 以代码形式

您账户中的每个监控对象都是一流的 API 资源。可单独管理,也可跨环境批量管理。

完整的监控配置

设备、任务和组管理

位置和时间表

警报和通知集成

XRS 实时报告数据流

工作原理

四步从零到自动化监控

无需安装 SDK。如果您的系统可以发出 HTTP 请求,就可以与 Dotcom-Monitor 通信。

01

创建集成

在您的 Dotcom-Monitor 账户中,转到 管理 > 集成 并创建一个新的 Web API 集成(用于配置)或 XML Feed 集成(用于报告)。可选择通过 IP 地址限制访问。

02

认证

每个请求都会针对您的集成进行认证。会话在 60 秒无活动后过期,保持访问时间短且安全。XRS 请求使用您生成的账号 UID (PID)。

03

发送 JSON 请求

调用 GET 读取,或 POST/PUT 写入。发送正文时设置 Content-Type: application/json。错误返回结构化 JSON。

04

全面自动化

将 API 连接到 Terraform、Jenkins、GitHub Actions、Azure DevOps 或您自己的脚本。在部署时触发监控配置,拉取性能数据到 BI,或在 SLA 违规时自动报警。

技术规格

两个 API。一个账户。完全控制。

Web API 负责配置;XRS 负责报告。它们共享单一认证模型,适用于所有 Dotcom-Monitor 解决方案。

Web API(配置与控制)

以编程方式管理您的监控基础设施。

基础 URL

api.dotcom-monitor.com/config_api_v1/

协议

HTTP,HTTPS

请求格式

JSON (application/json)

响应格式

JSON

方法

GET(读取)· POST,PUT(写入 / 更新)

认证

Web API 集成密钥,每次请求会话(60秒超时)

访问控制

IP 白名单可选

涵盖

监控 + LoadView 方法

管理对象

设备、任务、组、计划、过滤器、警报、位置、负载测试、用户

错误处理

带有错误代码和消息的结构化 JSON

XML 报告服务(XRS)

将实时监控数据流传输到任何支持 XML 的系统。

基础 URL

xmlreporter.dotcom-monitor.com/reporting/xml/

协议

HTTP,HTTPS

请求格式

带URL参数的HTTP(S) GET

响应格式

XML 文档

认证

账户UID(PID),作为XML Feed集成生成

范围

全账户或限定特定部门

报告类型

设备配置、状态、原始响应、汇总(小时/日/周/月/年)、3个月统计

数据窗口

原始响应可追溯至最近6个月内

筛选条件

位置、计划、设备、成功/失败、部门、日期范围

输出目标

仪表盘、SQL、Excel、Power BI、自定义应用

开发者友好

简单的HTTP。
无需SDK。

每个监控对象——设备、任务、警报、分组、计划——都表示为JSON资源。以下是从XRS拉取监控数据并通过Web API推送新设备的示例。将这些内容放入curl,bash脚本,Python任务,或CI步骤——无论您的团队已采用何种工具。

返回字段包括DnsTimeSSLTimeConnectionTimeRequestTimeFirstPacketTime (TTFB)DownloadTimeDuration,以及位置、状态和监控时间戳——可直接用于任何瀑布图视图。

# 拉取实时XRS报告——按位置汇总
GET https://xmlreporter.dotcom-monitor.com/reporting/xml/responses.aspx
     ?PID=4229AF4F0FB545AEA75EAF2013E51BB7
     &Site=12345
     &Type=Overall
     &location=NY, USA

# 响应(简化)
<Response>
  <ID>3424533543</ID>
  <Name>Checkout API</Name>
  <URL>https://shop.example.com/api/checkout</URL>
  <Duration>114</Duration>
  <DnsTime>0</DnsTime>
  <SSLTime>18</SSLTime>
  <ConnectionTime>15</ConnectionTime>
  <FirstPacketTime>97</FirstPacketTime>
  <DownloadTime>2</DownloadTime>
  <Status>S</Status>
</Response>

# 通过Web API创建新的HTTPS监控
POST https://api.dotcom-monitor.com/config_api_v1/devices
Content-Type: application/json

{
  "name": "Checkout API — 生产环境",
  "platform": "HTTPS",
  "tasks": [{
    "url": "https://shop.example.com/api/checkout",
    "method": "POST",
    "keyword": "order_id"
  }],
  "frequency": 60,
  "locations": ["NY-USA", "FR-PARIS", "SG"]
}

5分钟内开始自动化监控

所有付费方案均包含完整的Web API和XRS访问——无附加组件,无调用计费,无额外计费层级。

使用案例

团队使用API构建的内容

平台团队、SRE和DevOps工程师使用Dotcom-Monitor API将监控引入他们已经在使用的工作流程中。

监控即代码

对每个监控器与其保护的服务进行版本控制。通过现有的Terraform或Pulumi管道配置、更新和退役设备——确保预发布与生产环境之间无偏差。

部署后冒烟测试

在每次部署后,从Jenkins、GitHub Actions或Azure DevOps触发按需HTTPS和多步骤事务检查。新版本破坏关键端点时构建失败。

自定义状态页面和仪表盘

将XRS数据输出到面向客户的正常运行时间页面、内部NOC显示或高管SLA报告。只提取所需字段,完全按照您的格式呈现。

SLA证据与合规报告

直接从XRS自动导出每月SLA(正常运行时间%、P95 / P99响应时间、宕机事件)为Excel或PDF——文档化、时间戳记录且准备好审计。

批量设备配置

在收购、迁移或CDN切换后,一次性启动数百个监控器。克隆现有设备模板,并大规模分配正确的组、计划和警报路线。

第三方仪表盘嵌入

将监控数据与您的其他遥测数据一起导入Grafana、Power BI、Tableau或Datadog——外部合成检查与内部APM追踪相关联。

多租户账户管理

MSP和企业团队可通过程序化操作管理数百个部门和数千个设备,为每个客户提供部门范围的XRS数据流。

事件丰富

当监视器触发时,通过 XRS 自动拉取 waterfall、cipher 和 timing 分析,并附加到 PagerDuty 或 ServiceNow 事件中——减少分类时间。

XRS 深度解析

实时报告,完全符合您的需求

XML 报告服务是一个灵活、免费、按需的馈送。可请求摘要数据或原始响应。按位置、计划或成功状态过滤。仅返回您关心的字段。

报告类型
您获得的内容
典型用途
账户利用率
每个监控解决方案的已用和可用资源
许可证和容量规划,计费对账
设备状态
个别设备或设备组的当前状态
实时状态页面,NOC 大屏仪表盘
响应详情
请求级别高度可定制的时序和内容
详细诊断,自定义 waterfall,事件丰富化
设备与任务配置
导出的监控配置快照
备份、跨环境克隆、审计跟踪
摘要数据
正常运行时间、停机时间、成功次数、失败次数、性能、标准差
执行摘要,SLA 报告
原始响应
设备的每次检查结果,最多可追溯至 6 个月前
法医分析,历史比较
小时汇总
响应数据按1小时窗口分组
峰值负载识别,小时趋势分析
每日汇总
响应数据按24小时窗口分组
每日运营审查,工作日与周末比较
每周 / 每月 / 每年
跨较长时间范围的汇总
董事会级趋势,年度绩效报告
三个月统计
滚动三个月窗口计算的统计数据
基线衍生的告警,异常检测

每个报告都可以通过监控位置计划Dotcom-Monitor 过滤器成功或失败状态部门自定义日期范围进行筛选。

团队为何使用 API

为 DevOps、SRE 和平台工程而建

Dotcom-Monitor API 消除了监控流程中的手动 UI 点击,使您的团队能够在不增加人员的情况下扩展合成监测覆盖范围。

消除漂移

保持监控配置在源代码管理中。有信心在多个环境中应用相同的监控。

左移监控

在与服务覆盖同一个 PR 中添加合成检查。监控随着代码一起上线,而不是几周后。

无点击扩展

使用一个脚本即可启用一百个新域名或一千个新端点。没有点击疲劳。

细粒度安全

短时会话、可选的IP白名单以及部门范围的集成密钥确保访问安全。

适用于任何技术栈

纯HTTP + JSON(或用于报告的GET + XML)。无SDK锁定。支持所有语言和CI/CD工具。

拥有您的数据

按您的计划将监控数据导入您自己的数据仓库、BI平台或合规归档。

统一界面

一个API覆盖监控和LoadView负载测试——无需使用独立工具,无需独立凭证。

无额外费用

API和XRS访问包含在所有付费计划中。无按调用计费,自动化无额外费用。

客户反馈

“Dotcom最棒的功能之一是其推拉式API能力,为我们提供了网络性能数据。我们使用这些数据来监测性能问题以及页面加载统计。Dotcom-Monitor让我们能够在一个界面和平台中监控多个服务,提高了我们的运营效率。”
Gregory S.
经理,广播媒体 · 经过验证的Capterra评价

准备让监控自动化运行了吗?

每个30天试用包含完整的Web API和XRS访问权限——以及所有监控解决方案、所有位置和所有集成。体验自动化监控的感觉。

常见问题

关于Dotcom-Monitor API的常见问题

Web APIconfig_api_v1)是一个基于JSON的REST接口,用于创建和管理监控配置——设备、任务、组、计划、警报和负载测试。XML报告服务(XRS)是一个独立的免费数据源,通过HTTP GET返回XML格式的监控结果。大多数团队同时使用两者:使用Web API进行配置,使用XRS提取结果。

在您的Dotcom-Monitor账户中,前往管理 > 集成 > 新建集成,创建一个Web API集成(用于配置)或XML Feed集成(用于XRS)。每个Web API请求都通过该集成进行身份验证,且会话在60秒无活动后过期。XRS使用生成的账户UID作为PID URL参数。您还可以通过IP地址限制访问。

Web API完全基于JSON——请求体和响应均使用JSON。发送JSON正文时请设置Content-Type: application/json。XRS通过HTTP(S) GET返回XML文档,因此请求只是带查询参数的URL。

Web API覆盖Dotcom-Monitor的所有监控平台:HTTPS、REST、SOAP、GraphQL、WebSocket、ServerView、BrowserView、UserView(EveryStep脚本)及MetricsView,以及全部协议监控(DNS、SSL、电子邮件、FTP、ICMP Ping、TCP端口、Traceroute、VoIP等)。它还涵盖了完整的LoadView负载测试功能。

API和XRS访问包含在所有付费计划中——不存在按调用计费或附加费用。会话在60秒无活动后过期,自然限制了长时间运行的脚本。如果您需要IP限制访问或企业级吞吐量,请联系销售了解企业方案。

XRS可以返回最长6个月的原始响应数据。总结和统计报告(按小时/日/周/月/年聚合及3个月统计)可查询更长时间。您可指定每个报告的起止日期和时间。

可以——任何能够发起HTTP调用的工具都能驱动API。团队通常与Jenkins、GitHub Actions、GitLab CI、Azure DevOps、CircleCI及Terraform集成,用于部署时自动配置监控,发布后运行烟雾测试,以及基于监控健康状况控制生产发布。

可以。在创建Web API集成时,您可以允许所有认证请求访问,或限制访问至信任的IP列表。详情请参见知识库中的如何为Web API访问设置IP白名单文章。

支持。根账户用户可以通过编程方式管理部门,XML Feed集成可限定到特定部门。部门受限用户仅能拉取其所属部门的XRS报告,便于MSP和多租户环境的清晰分隔。

完整文档位于Dotcom-Monitor知识库,包括API入门指南、监控及LoadView方法参考含JSON示例,以及XRS请求参数参考。代码示例区提供可直接使用的代码模板。

自动化监控。重新获得工程时间。

加入超过10,000个组织,使用Dotcom-Monitor在客户发现问题前捕捉故障——并使用API和XRS轻松管理覆盖范围。