云 API 使用 API Inspector

API Inspector 是云 API 新推出的一款产品功能,用户可通过此功能查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

相关产品
云 API 产品页,含版本规格、价格与购买入口。

一、功能特性

API Inspector 与 API Explorer 共同成为腾讯云 API 用户学习和调试 API 的一体化解决方案,具有以下特性:

·自动录制:如果你想要了解功能背后的 API,可在控制台操作相应的功能时获得相关 API 调用信息,详情请参见 自动录制 API 调用。

·一键生成:自动生成各语言的 API 代码片段参数预填充,可直接运行,详情请参见 一键生成 API 代码。

·在线调试:提供 API Explorer 一键在线调试功能,可实现自动生成多语言 SDK 代码、在线调用、发送真实请求及签名串自动生成等功能。降低了 SDK 的使用难度,详情请参见 API Explorer 在线调试。

·响应结果:支持一键查看本次调用的响应结果,详情请参见 查看响应结果。

二、开启 API Inspector 功能

请按照以下步骤,开启 API Inspector 功能:

1. 登录 云服务器控制台。

2. 选择页面上方的工具 > API,即可开启 API Inspector 功能。如下:

三、自动录制 API 调用

注意:说明:

注意:录制前,请确保已 开启 API Inspector 功能,否则会录制不到调用接口。

以下以实例改名操作为例,介绍 API Inspector 的自动录制功能:

1. 在实例操作列表单击“改名”操作,将实例名称修改为 API Inspector。具体操作请参见 修改实例名称。

2. 在 API Inspector 展示的接口列表,即可查看到改名操作调用到的ModifyInstancesAttribute修改实例的属性接口。类似的,也可通过为实例重装系统,在 API Inspector 接口列表查看到涉及到的InquiryPriceResetInstance(重装实例询价)、ResetInstance(重装实例)接口。

3. 你可勾选隐藏 Describe 类接口,查看功能核心接口。如下:


四、一键生成 API 代码

当控制台操作涉及的 API 录制完成后,你可单击 API 名称,一键生成 Java、Python、Node.js、PHP、Go 及 .NET 语言的 API 代码片段及参数预填充。可选择  复制对应格式的代码段:


五、API Explorer 在线调试

你可选择  或前往API Explorer,使用 API Explorer 工具直接调试对应的功能,也可选择  查看对应接口文档。如下:


六、查看响应结果

你可选择  查看本次调用的响应结果,查看完毕后选择  收起响应结果。如下:


赞 (0)
上一篇 4天前
下一篇 4天前