API作为开发者使用ZStack Cloud的重要桥梁，一直备受开发者的依赖与关注。随着ZStack Cloud产品版本迭代，功能愈发丰富，提供给开发者的API数量也急剧增加，目前开放使用的API数量已超过1000条大关。再加上纷繁复杂的业务场景，API调用更加灵活多变，致使开发者，尤其是入门新手，往往会在开发道路上遇到一些“拦路虎”，本想大显身手，却被束手束脚，比如：
组合查询条件复杂，不知道应该增加哪些条件
API范例不够丰富，没有覆盖所有场景，无法满足自己的需求
遇到疑难问题，排查、咨询耗时耗力
一键开启：一条命令，全局开启该功能 UI可视化：以时间轴方式实时呈现API记录 自由操作：页面操作不受限，指哪儿查哪儿 一键复制：Curl命令、Request URL支持一键复制到第三方工具 多账户推送：不同视角下的API调用情况，一目了然
1.开启方式：一条命令，全局开启
管理员登录管理节点终端，执行以下命令，即可在ZStack Cloud云平台全局范围内一键开启/关闭API Inspector功能：
如果您为ZStack Cloud基础版/标准版/企业版用户，均可使用上述方法启用该功能。
2.API记录：自由操作，实时呈现
当API Inspector功能开启后，用户登录ZStack Cloud云平台，即可在页面上方导航栏右侧看到API Inspector功能入口。展开查看实时API记录，记录会根据调用时间流呈现。
无论“API记录”窗口打开或关闭，界面调用的API情况都会被记录下来。推荐先点击“清空记录”按钮，再在UI界面上进行相关操作，查看实时API记录，比如查询资源、增删改资源等。
API记录可根据请求类型进行筛选，显示筛选后的最近100条记录。支持以下几种请求类型：
GET：查询类 - 查询资源
GET-ZQL：查询类 - 通过ZQL语句查询资源
POST：操作类 - 创建资源
PUT：操作类 - 修改资源
DELETE：操作类 - 删除资源
图1：实时API记录
3.API详情：一键复制，快速调试
点击对应API右侧“查看详情”按钮，进入API记录详情页，可查看该API记录的详情信息，包括当前API的调用ID、请求方法、请求URL、请求头、请求体、Curl请求示例、响应结果、响应耗时等信息。其中，API调用ID可用于快速定位当前调用在管理节点前端和后端的日志记录，方便快速排查问题。对于GET-ZQL类型请求详情，特别支持查看ZQL语句，方便用户参考学习，快速掌握使用技巧，提高查询效率。所有代码段均支持复制，方便用户在第三方工具调试使用。
图2：API记录详情
4.使用建议
图3：ZStack Cloud开发手册
图4：API Inspector技术框架
在功能设计之初，API请求记录是在UI-Server请求完成后向UI端推送，若遇到网络不稳定的情况时，会让使用者有记录丢失的错觉。为了让记录更准确更实时，我们将同一条API请求，在推送消息时拆分成Request和Response两种类型，收到Request消息即展示，收到Response消息进行更新。
