API全景图

目录

• 一、功能概述
• 二、核心功能
  • （一）应用调用关系图
  • （二）右侧统计面板
  • （三）底部异常日志详情表格
• 三、常见问题
  • （一）应用调用关系图中为什么会显示IP节点?

---

一、功能概述

API全景图是系统监控模块的重要组成部分，用于可视化展示系统中各应用之间的调用关系、请求统计及响应性能等信息。本页面提供了多维度的数据分析视图，帮助运维人员快速掌握系统运行状况。

1. 层级钻取：支持从全局调用关系图逐层深入到具体节点的调用细节
2. 多维度筛选：可根据时间范围筛选数据，支持历史数据回溯
3. 实时监控：动态展示请求统计和性能指标的变化趋势
4. 故障诊断：通过失败请求数和响应时间异常快速定位问题节点

二、核心功能

（一）应用调用关系图

左侧主区域展示了系统内应用的调用拓扑结构，采用节点-连线图示表示：

1. 一级视图（全局概览）：

   
   • 节点类型：
     • 蓝色立方体：内部系统
     • 橙色菱形：外部系统
     • 灰色立方体：未参与调用的系统
   • 连接线：显示调用关系及流量指标（如"0/2"表示失败次数/总次数）

2. 二级视图（节点钻取）：

   
   • 点击一级视图中任意节点后，展开该节点的详细调用关系
   • 左侧展示调用方与当前节点具体API的调用关系
   • 右侧展示当前节点与其他系统的调用关系(如果存在)
   • 返回按钮支持回到上一级视图

（二）右侧统计面板

包含三个关键数据可视化模块：

1. 请求统计：

   • 绿色：显示总请求数
   • 红色：显示失败请求数

2. 请求次数分布图：

   • X轴表示时间点
   • Y轴表示某个时间的请求次数(包含总次数、成功次数、失败次数)

3. 响应时间分布图：

   • X轴表示时间点
   • Y轴表示某个时间的平均请求耗时(包含总耗时、平台耗时、系统耗时)

（三）底部异常日志详情表格

异常日志详情记录系统中的API异常调用信息，可以看到API调用的访问日志详情信息，用于分析调用问题和优化API性能。

参数	说明
请求时间	该次请求发生的时间。
请求ID	请求唯一ID。
API名称	调用API的名称。
版本	调用API的版本号。
应用系统	调用该API的应用系统，若API认证方式为无认证，则为空。
资源组	调用API的所属资源组。
调用路径	该次调用的路径。
后端主机	网关转发到后端主机的实际路径。
后端路径	网关转发的后端主机地址。
客户端IP	调用者的IP。
状态	响应状态，分为成功和失败两种状态
响应码	响应状态码。
响应时间	总体响应时间，单位为毫秒。

三、常见问题

（一）应用调用关系图中为什么会显示IP节点?

在调用API时，以下情况下请求方会被识别为IP而不是一个系统：

• 请求方未携带token
• 请求方为外部系统时，未订阅该API
• 该API的功能开关配置中的认证功能未启用