API Inspector

API Inspector：云平台API调用的监视工具，用于记录用户在云平台上操作时所关联调用的API。

API Inspector支持记录云平台所有查询类和增删改操作类API的调用情况。所有API记录支持分类筛选，可用于问题排查、学习参考、第三方工具调试使用，可大幅提高开发运维效率。

API Inspector使用方式

使用API Inspector查看API调用可参考以下三步：

启用API Inspector。
查看云平台操作所关联的请求记录。
查看请求详情和日志。

启用API Inspector。

进入管理节点系统，运行以下命令启用API Inspector：

#启用API Inspector
zstack-ctl config_ui --api_inspector=true

# 重启管理节点UI服务
zstack-ctl stop_ui
zstack-ctl start_ui

查看云平台操作所关联的请求记录。
进入ZStack Cloud云平台，在云平台进行相应操作，例如查看报警记录。在云平台UI界面右上角，点击API图标，弹出API记录窗口。
API调用记录按时间线实时滚动显示，最多可显示最新100条记录。支持两种API调用视图：
- 按UI请求分组：按UI请求 (GQL) 对所调用的API进行分组归纳，一个UI请求通查对应一个UI操作或查询。点击UI请求详情，可展开查看该UI请求关联的一组后端API。
- 按平铺：扁平展示云平台操作所关联的所有API记录，包括前端请求和后端请求。
API Inspector支持筛选和搜索，包括按请求类型筛选、按请求耗时搜索、按请求地址搜索：
- 按请求类型筛选：平铺视角下，支持按请求类型进行筛选：
  - GQL：UI请求，通查对应一个UI操作或查询
  - GET: 查询类API，查询资源时调用该类API
  - GET-ZQL: 查询类API，通过ZQL语句查询资源时调用该类API
  - POST: 操作类API，创建资源时调用该类API
  - PUT: 操作类API，修改资源时调用该类API
  - DELETE: 操作类API，删除资源时调用该类API
- 按请求耗时搜索：在耗时搜索框内指定一个耗时时间，API Inspector将自动筛选出等于/超过该耗时的请求或没有完成的请求。如请求前的耗时时间列显示Webhook，则表示该异步请求正在等待Webhook推送执行结果。
- 按请求地址搜索：在地址搜索框内指定一个地址或关键字，API Inspector将自动筛选出包含该关键字的请求
如图 1、图 2、图 3所示：
图 1. 按请求类型筛选

图 2. 按请求耗时搜索

图 3. 按请求地址搜索
查看请求详情和日志。
- 查看API详情：点击对应API右侧详情按钮，进入详情页，可查看该API记录的详情信息，包括当前API的调用ID、请求方法、请求URL、请求头、请求体、Curl请求示例、响应结果、响应耗时等信息。其中，API调用ID可用于快速定位当前调用在管理节点前端和后端的日志记录，方便快速排查问题。对于GET-ZQL类型请求详情，特别支持查看ZQL语句，方便用户参考学习，快速掌握使用技巧，提高查询效率。所有代码段均支持复制，方便用户在第三方工具调试使用。
- 查看API日志：点击对应API右侧Log按钮，进入Request Log页，可查看该请求相关的日志信息，帮助用户更好掌握该请求的执行情况。日志支持自动换行展示。
如图 4、图 5所示：
图 4. 查看请求详情

图 5. 查看请求日志

注意事项

使用API Inspector需注意：

启用API Inspector后，涉及大量数据传输，使用完成后，建议及时关闭该功能，否则可能影响云平台UI服务正常运行。可进入管理节点系统运行以下命令关闭该功能：
```
#禁用API Inspector
zstack-ctl config_ui --api_inspector=false

# 重启管理节点UI服务
zstack-ctl stop_ui
zstack-ctl start_ui
```
建议不要在生产环境使用该功能。