熟悉腾讯云API的同学都知道,腾讯云API可以快速地执行某些指令以及使用某些产品,帮助我们告别传统控制台打开浏览器、登陆账号、寻找产品多次点击获得结果的流程。几行代码,一个指令就能带来肉眼可见的效率提升。
同时,腾讯云API高灵活的特性,可以实现很多控制台无法提供的功能。我们可以通过腾讯云API来自由组合,定制化开发。
当你想要在多个区域开设虚拟机、批量修改虚拟机密码,甚至想要批量退还虚拟机时,在控制台进行这些操作都具有很高的重复性,而且没办法一步到位。如果这些需求是我们周期性出现的,那我们就可以通过云API定制一个单独的小工具,进而快速实现这些功能,降低我们的时间成本,并大大提升我们的效率。
然而,作为初级研发者或运维的我,对代码并不熟悉。如果我也想使用API,想知道这个功能调用哪个接口,想了解出入参调用,并希望用代码脚本解决问题提升效率,该如何下手?
这个时候,API Inspector就派上用场了。
API Inspector将API与控制台紧密连接,你可以一边操作控制台,一边了解每次操作背后的API,并根据其自动生成的代码,自主学习和调试完成功能的使用。
接口查询,代码生成,一键调试同时搞定,API Inspector助你轻松玩转腾讯云API。
API Inspector是什么
API Inspector 是腾讯云 API 用户学习和调试 API 的一体化解决方案之一,通俗的说,就是帮助用户学习、调试API并完成使用的工具。
通过API Inspector,你可以清晰地看到控制台每一步操作关联的 API 调用情况,查看自动生成各语言版本的 API 代码,进而前往 API Explorer 进行在线调试。
左上角区域可以查看本次调用入参;左下角区域各语言自动生成代码,可复制直接运行;右侧区域即可查看每一步操作背后的API。
简单来说,API Inspector的功能可细分为:
自动录制:如果你想要了解功能背后的 API,可在控制台操作相应的功能时获得相关 API 调用信息。
一键生成:自动生成各语言的 API 代码片段参数预填充,可直接运行。
在线调试:API Explorer 一键在线调试功能,可实现自动生成多语言 SDK 代码、在线调用、发送真实请求及签名串自动生成等功能,降低了 SDK 的使用难度。
如何使用API Inspector
这样一个好用的云API工具,如何使用?
开启API Inspector功能
登录云服务器控制台,选择页面上方
【API】即可开启 API Inspector 功能。
自动录制API调用
以修改实例名称为例,介绍 API Inspector 的自动录制功能。
在控制台点击操作【改名】,将某个实例名称修改为 API Inspector。开启 API Inspector 功能,即可查看涉及改名操作的所有 API 调用。
你可勾选“隐藏Describe类接口”,查看功能核心接口。如下图所示:
一键生成API代码
当控制台操作涉及的 API 录制完成后,您可单击 API 名称,一键生成 Java、Python、Node.js、PHP、GO 及 .NET 语言的 API 代码片段及参数预填充。
可选择复制
复制对应格式的代码段:
API Explorer在线调试
您可选择
或【前往API Explorer】,使用 API Explorer 工具直接调试对应的功能,也可选择
查看对应接口文档:
这样,API Inspector就能手把手地教你完成学习和调试API了 。
你说说,有了API Inspector,上手云 API 是不是 easier!
API Inspector 功能目前正处于灰度阶段。目前仅在云服务器控制台的实例、专用宿主机、置放群组、弹性伸缩,SSH密钥以及回收站菜单中开放。
API Inspector 仅展示公开的云API 3.0 接口信息。刷新浏览器当前页面,此前的调用记录也会被清空。
推荐阅读