API 监控
快速阅读
API 监控观察客户系统调用开放接口是否健康:有没有调用、是否成功、失败原因、是否触达频次限制、响应是否变慢。它是联调、上线值守和排障入口,不替代接口文档,也不替代话单。
- 关注调用量、成功率、失败率、响应耗时、错误原因、频次限制和调用方信息。
- 排查顺序建议:鉴权 → 参数 → 频次 → 业务状态 → 响应结果 → 日志/话单核对。
- 接口调用成功不等于业务最终成功(例如外呼受理成功,是否接通仍看通话记录和话单)。
阅读地图
- 是什么:读「二」。
- 字段与失败分类:读「六」和附录 B。
- 联调与上线:读「七」和附录 C。
一、文档说明
客户系统可能通过开放接口查询话单、发起外呼、查询监控、获取录音或同步业务结果。缺少 API 监控时,常分不清请求是否到达、失败属于鉴权/参数/频次还是业务状态、以及如何与客户系统对账。本文给技术负责人、实施、产品和运营说明监控口径与交付建议。
本文主要说明开放接口调用监控。具体接口文档、签名算法细节和客户侧代码实现见对应专题或联调方案。
二、产品总览
API 监控记录或汇总请求时间、接口类型、调用结果、失败原因、响应耗时和调用频次,帮助判断对接是否正常。
主要回答:是否成功调用、失败类型、失败是否集中、响应是否变慢、是否超频、能否与话单/任务/录音或业务记录对上。
三、核心概念
| 概念 | 含义 |
|---|---|
| 开放接口 | 面向客户系统的标准能力入口,如查询记录、发起外呼、查询监控、获取录音、同步业务结果等 |
| 调用结果 | 请求是否成功处理;失败时尽量给出可理解类型,如鉴权失败、参数错误、频次限制、资源不存在、业务状态不允许 |
| 响应耗时 | 从接收请求到返回结果的时间;异常可能来自平台处理、客户网络、数据量或查询条件 |
| 频次限制 | 保护平台稳定性;超过约定频率可能触发限制或失败提示 |
| 请求标识 | 定位一次调用;结合请求时间、接口名称、调用方、业务标识排障 |
四、对象关系与数据流
客户系统发起 API 调用
↓
平台进行鉴权、参数校验、频次校验和业务处理
↓
返回成功或失败结果
↓
API 监控记录调用状态、耗时和错误原因
↓
结合话单、任务、录音、日志或客户系统记录排障五、能力地图
| 能力 | 说明 |
|---|---|
| 调用概览 | 调用量、成功率、失败率和耗时概览 |
| 明细查询 | 按时间、接口、调用方、结果、业务标识查询 |
| 失败分析 | 鉴权、参数、频次、业务状态等失败原因 |
| 耗时分析 | 识别响应耗时异常接口 |
| 对账关联 | 通过业务标识、通话标识或任务标识关联业务结果 |
| 权限控制 | 控制可查看的调用数据和明细内容 |
六、产品功能说明
概览指标
| 指标 | 说明 |
|---|---|
| 调用总量 | 一段时间内接口调用次数 |
| 成功次数 | 成功返回的调用次数 |
| 失败次数 | 失败返回的调用次数 |
| 成功率 | 成功次数占调用总量的比例 |
| 平均响应耗时 | 接口平均处理耗时 |
| 慢请求数 | 响应耗时超过阈值的请求数量 |
| 频次限制次数 | 触发频次限制的请求数量 |
明细字段与筛选
明细常见字段:请求时间、接口名称或类型、调用方标识、请求结果、失败原因、响应耗时、请求标识、业务标识、通话标识或任务标识、客户侧请求来源。
常见筛选:时间范围、接口名称、调用方、请求结果、失败原因、响应耗时范围、业务标识、通话标识、任务标识。
失败原因分类
| 类型 | 说明 |
|---|---|
| 鉴权失败 | 签名、凭证、时间戳或权限不正确 |
| 参数错误 | 必填缺失、格式错误或取值不合法 |
| 频次限制 | 调用超过约定频率 |
| 资源不存在 | 查询对象不存在或无权限访问 |
| 业务状态不允许 | 当前业务状态不支持该操作 |
| 系统繁忙 | 平台处理繁忙或临时不可用 |
| 客户网络异常 | 客户侧请求链路异常,需客户侧配合排查 |
七、典型业务场景
调用失败:按时间和接口查是否到达平台,再看失败原因;参数错误对照接口文档,频次限制调整调用策略。
发起外呼成功但客户未接到:接口成功只代表受理;是否发起、接通及失败原因继续看外呼记录、话单和通话日志。
响应变慢:按接口看平均耗时和慢请求,判断查询范围、请求集中、客户网络或平台压力。
上线联调值守:观察调用量、失败率和错误原因,及时发现签名、参数、时间戳和频次问题。
八、上线准备与运营建议
上线前确认:调用哪些开放接口;鉴权、时间戳、签名和权限范围;调用频率与限流;业务/通话/任务等对账字段;双方排查责任;正向、参数错误、鉴权失败、频次限制等验收用例。
运营建议:联调看失败明细;上线初期看失败率和耗时;稳定期关注异常峰值、频次限制和客户系统变更。调用成功不等于业务最终成功。
九、与周边能力的关系
| 能力 | 关系 |
|---|---|
| 接口文档 | 参数或鉴权问题对照文档修正 |
| 话单 | 通话类接口最终结果通过话单核对 |
| 任务记录 | 外呼任务类接口结合任务和名单记录核对 |
| Webhook 监控 | API 是客户主动调用;Webhook 是平台主动推送 |
| 日志 | 技术定位请求处理细节和异常原因 |
| API 请求速率限制 | 频次限制的约定与监控观察入口互补 |
十、FAQ
API 调用成功是否代表外呼成功?
不一定。接口成功通常表示请求被受理;是否接通需查看通话记录和话单。
API 监控能看到完整请求内容吗?
取决于产品权限和脱敏策略。号码、密钥或敏感信息应脱敏。
为什么会触发频次限制?
可能短时间调用过多,或批量任务未节流。按接口约定调整频率。
十一、总结
API 监控关注接口调用是否健康;业务最终结果仍需结合话单、任务、录音、报表和客户系统记录核对。
附录 A:入口与权限
| 权限项 | 说明 |
|---|---|
| 页面权限 | 是否可查看 API 监控 |
| 调用方范围 | 可查看哪些客户系统或应用调用 |
| 明细权限 | 是否可查看请求明细和失败详情 |
| 脱敏权限 | 控制号码、业务参数和敏感字段展示 |
附录 B:关键字段口径
| 字段 | 说明 |
|---|---|
| 请求时间 | API 调用发生时间 |
| 接口名称 | 被调用的开放接口能力名称 |
| 调用方 | 发起请求的客户系统或应用 |
| 调用结果 | 成功或失败 |
| 失败原因 | 失败分类和说明 |
| 响应耗时 | 接口处理并返回结果的耗时 |
| 请求标识 | 定位单次调用的标识 |
| 业务标识 | 客户系统传入或约定的业务关联字段 |
附录 C:实施检查清单
- 接口范围、鉴权与签名、频次限制已确认。
- 成功调用、鉴权失败、参数错误、频次限制已验证;业务标识可与话单或任务记录关联。
附录 D:常见问题速查
| 现象 | 优先检查 |
|---|---|
| 请求失败 | 鉴权、参数、权限、频次限制 |
| 请求成功但业务失败 | 业务状态、话单、任务记录、日志 |
| 响应变慢 | 查询范围、请求量、客户网络、平台压力 |
| 查不到调用记录 | 时间范围、调用方、权限、请求是否到达平台 |
Updated about 2 months ago