API 监控

API 监控让你自动验证 API 端点是否可访问、性能是否达标、返回的数据是否正确。这有助于确保你的应用和集成按预期工作。

和其他监控一样，如果 API 监控发现问题，你可以和团队一起解决该事件，也可以选择更新你的状态页。

主要功能

• 从全球多个地区每 30 秒测试一次你的 API 端点。
• 校验 HTTP 状态码、JSON 响应体、响应头和响应时间。
• 附带自定义请求头、查询参数或 JSON 负载。
• 端点出现故障、变慢或返回意外结果时立即收到通知。
• 支持 Slack、邮件、短信、电话呼叫、webhook 等多种渠道。

添加第一个 API 监控

要创建监控，请进入你的项目 → 监控 → 添加监控。

监控类型

选择 API 作为监控类型。

填入你要监控的端点 URL——例如
https://api.yourservice.com/v1/users。

请求配置

你可以完全自定义 API 请求：

• HTTP 方法：GET、POST、PUT、PATCH、DELETE、OPTIONS 或 HEAD
• **请求体：**随请求发送 JSON、表单数据、GraphQL 或纯文本
• **认证：**添加基本认证、API 密钥或 Bearer 令牌授权
• **查询参数：**在请求 URL 后追加键/值对
• **请求头：**添加 API 请求所需的自定义请求头

满足以下条件时视为监控成功

只有当所有指定的断言都满足时，API 监控才算成功。
你可以设置以下一个或多个断言：

• **状态码：**例如响应为 200 OK
• **响应时间：**例如低于 1 秒
• **响应体包含：**例如 "success": true
• **JSON 路径：**例如 data.status 等于 "active"
• **响应头包含：**例如 Content-Type: application/json

只要其中任何一个条件不满足，监控就会被标记为故障，并按照你的告警设置发送告警。

高级设置

• **易记名称：**给监控起一个有辨识度的名称，方便识别。
• **检测间隔：**决定测试端点的频率。
• **检测地区：**选择测试地区（美国、加拿大、欧洲、亚洲）。
• **添加到状态页：**公开展示 API 的正常运行时间和响应统计。
• **当监控出现故障时：**创建事件、通知订阅者，或发布到你的状态页。
• **当监控恢复时：**解决事件并自动更新你的状态页。