文档

API Inspector

更新时间:

API Inspector是一个实验性的功能,旨在让用户查看控制台的每一步操作背后的API调用,并自动生成各语言版本的API代码,可通过Cloud Shell和API Explorer在线调试。

功能特点

API Inspector与API Explorer、Cloud Shell集成到一起,构成阿里云用户学习和调试API的一体化解决方案,具有以下特性:

  • 自动录制:根据您需要的功能,在控制台操作相应的功能即可获得相关API调用。更多信息,请参见自动录制功能

  • 一键生成:自动生成各语种的API代码片段参数预填充,可直接运行。更多信息,请参见一键生成API代码

  • 在线调试:结合API Explorer、Cloud Shell一键在线调试,免开发环境搭建。更多信息,请参见API Explorer在线调试Cloud Shell在线调试

开启API Inspector功能

完成以下操作,开启API Inspector功能:

  1. 登录传统型负载均衡CLB控制台

  2. 单击页面右下角的api

自动录制功能

本文以修改负载均衡实例名称为例,演示API Inspector的自动录制功能。

  1. 找到目标实例,单击实例ID。

  2. 实例详情页签,在基本信息区域单击名称后面的编辑,修改实例名称。

  3. 单击确定,完成实例名称修改。

  4. 单击页面右侧的2,可以看到上述操作所调用的API。

    您可以勾选隐藏Describe类接口,查看功能核心接口。

一键生成API代码

控制台操作的功能调用的API录制完成后,单击API名称,一键生成Python、Java、Go、Node.js、PHP和CLI格式的API代码片段参数预填充。

说明

单击图表2复制对应格式的代码段,可直接运行。

API Explorer在线调试

控制台操作的功能调用的API录制完成后,在API Inspector弹框中单击前往OpenApi平台,可以转到OpenAPI开发者门户调试对应的功能。

说明

将鼠标悬停在API接口上,您可以单击图标1查看文档和调用API的详细参数设置信息。

Cloud Shell在线调试

控制台操作的功能调用的API录制完成后,展开调用API详情后,单击图标3,可以使用Cloud Shell一键在线调试功能。

说明

使用Cloud Shell一键调试功能,推荐关联并创建一个OSS Bucket保存您常用脚本和文件,但会产生少量的OSS使用费用。也可以选择暂不创建。

负载均衡使用Cloud Shell调试功能的云命令行格式如下:

aliyun slb actionName --parameter1value1 --parameter2value2...

如本次示例中调用的SetLoadBalancerName接口修改负载均衡实例名称为SLB1,运行的云命令行为:

aliyun slb SetLoadBalancerName --RegionId cn-hangzhou --LoadBalancerName SLB1 --LoadBalancerId lb-bp1b6c719dfa08exf****

返回值为:

{"RequestId":"14466282-B00F-49C1-B11E-FB8D3772E3DA"}
图标4