接口简介
「API 可用性与延迟评分」是数据鱼API平台提供的服务指标换算接口,Base 路径 /api/api-monitor,共 3 个端点,提供两个独立的小工具:uptime 把「统计周期总分钟数与停机分钟数」换算成可用性百分比并给出 SLA 达标结论;latency 把「响应延迟毫秒数」换算成 0-100 的评分与评语。两者都面向监控报表与状态页的后处理环节——监控系统通常直接产出原始计数,而报表需要统一的百分比、评级与阈值结论,本接口把这一层口径固化下来。
uptime 的口径为:可用性 =(总分钟数 − 停机分钟数)/ 总分钟数 × 100,保留四位小数;结论按固定阈值 99.9(三个九)判定,达到阈值输出 Met (Three Nines),否则输出 Violated。默认参数 43200 分钟恰为 30 天的分钟数,即按自然月为默认统计周期。latency 的口径为:评分 = 100 − 延迟毫秒数/10,下限 0,保留一位小数;评级按固定分界划分——低于 100ms 为 Excellent,低于 500ms 为 Fair,其余为 Poor。
计算均为无状态的即时算术,不存储任何监控数据,也不采集调用方信息,输入什么换算什么,结果可完全复算。适合嵌入告警流水线、生成周报或验证 SLA 条款是否达成。
接口共 3 个端点:免鉴权的健康检查,加 uptime 与 latency 两个计算端点。
端点总览
方法 路径 说明 鉴权
GET /api/api-monitor/ping 健康检查(免鉴权) 免鉴权
GET /api/api-monitor/uptime 可用性百分比与 SLA 达标判定 需要
GET /api/api-monitor/latency 延迟评分与评级 需要
通用约定
鉴权使用 X-API-Key 请求头或 ?api_key= 查询参数,全站统一 Key:缺失返回 4011,无效返回 4013。响应为统一三段结构 {code, msg, data},code 为 0 表示成功。本接口参数均为可选数值,常规调用不触发参数错误;传入非数值会被强制转 0 参与计算而不报 4002,因此输入合法性由调用方自行把关。其余错误:4001 缺少参数、4004 目标不存在、5032 上游服务不可用。鉴权与响应结构为数据鱼API平台全站统一约定。
核心端点详解
可用性换算(GET /uptime)
用途:由统计周期与停机时长换算可用性百分比,并按三个九阈值给出 SLA 结论。
参数 类型 必填 默认 说明
total int 否 43200 统计周期总分钟数,默认 30 天
down int 否 0 停机分钟数
返回字段要点:total_minutes 与 downtime_minutes 回显输入;uptime_percent 为可用性百分比,保留四位小数;sla_status 为达标结论,百分比不低于 99.9 时为 Met (Three Nines),否则为 Violated。
请求示例:
GET /api/api-monitor/uptime?api_key=YOUR_KEY&total=43200&down=43
延迟评分(GET /latency)
用途:由响应延迟毫秒数换算 0-100 评分与三档评级。
参数 类型 必填 默认 说明
ms int 否 100 响应延迟,毫秒
返回字段要点:latency_ms 回显输入;score 为评分,计算式为 100 减延迟毫秒数的十分之一,下限 0,保留一位小数;rating 为评级——低于 100ms 为 Excellent,低于 500ms 为 Fair,其余为 Poor。
请求示例:
GET /api/api-monitor/latency?api_key=YOUR_KEY&ms=350
健康检查(GET /ping)
免鉴权,无请求参数,返回服务名称与版本号,用于探活与部署确认。
GET /api/api-monitor/ping
数据与限制
uptime 的 SLA 阈值固定为 99.9,结论文案固定为 Met (Three Nines) 与 Violated 两种;接口不支持自定义阈值。
latency 的评分下限为 0(延迟 1000ms 及以上评分均为 0),评级分界固定为 100ms 与 500ms。
百分比保留四位小数、评分保留一位小数;除此之外不做任何取整或钳制。
两个端点均为纯算术换算,无缓存、无外部依赖;不存储监控样本,历史趋势需调用方自行持久化。
典型使用场景
状态页与 SLA 周报:把监控系统导出的月度停机分钟数换算成百分比与达标结论。
告警流水线:对探测到的延迟做统一评分,按 rating 分档触发不同级别的通知。
接入验收:在集成测试中用固定输入验证网关延迟是否落入预期评级。
注意事项
文档与实现的差异以实测为准:文档中 latency 端点的响应示例误用了 uptime 的字段(total_minutes 等),实际返回为 latency_ms、score、rating 三字段,集成时请按实测结构解析。
输入不做业务校验:down 大于 total 会得到负百分比,total 为 0 会触发除零错误(5000),负数与非数值输入会被静默转换,调用方应在提交前完成合法性检查。
SLA 结论只对应 99.9 单一阈值;若合同口径是 99.95 或 99.99,接口结论只能作参考,需自行按 uptime_percent 复判。
延迟评分模型是线性简化口径,与真实用户感知或 P95/P99 分位统计无对应关系,用于报表展示尚可,不宜作为性能优化目标本身。
本接口属于数据鱼API平台开发工具类接口,鉴权与响应结构与其他接口一致。