OpenAPI 是强大工具集,允许开发者通过编程方式管理和调用各项服务,如 ECS(弹性计算服务)、OSS(对象存储服务)、SMS(短信服务)等。本文旨在引导您从零开始,掌握如何在线调试 OpenAPI,具体方法,大家可以参考下。
开通云产品服务
您可以通过以下两种方式开通您所需要的云产品服务,例如开通短信服务:
可访问开通助手一键开通云产品服务。搜索短信服务,选中短信服务,单击一键开通。
访问各云产品控制台,点击开通。例如在短信服务控制台单击开通。
重要
只有开通了云产品服务,才能调用该云产品的OpenAPI。
在线调试 API
登录阿里云OpenAPI门户,选择您已开通服务的云产品(例如云服务器ECS),点击去调试。
在调试页面,选择您想要调试的API,例如调试云服务器的DescribeInstanceTypeFamilies接口,可参阅API文档后,在参数配置区域填写符合要求的参数,单击发起调用。更多详细内容请参阅API 在线调试。
调用结果
发起调用之后,可在右侧查看调用结果。调用结果页签中可以查看接口返回的状态码和接口返回的数据。
调用成功
调用报错
API 调用结果的状态码一般为200。返回的数据结构一般是 JSON 格式,其中各业务响应字段的含义可通过 API 文档查看,例如云服务器的 DescribeInstanceTypeFamilies API 的响应参数文档如下。
SDK 示例
支持在SDK 示例页签,选择SDK 版本,选择SDK 语言,单击运行示例调试。
CLI 示例
支持在CLI 示例页签,单击右侧运行命令按钮进行在线调试。
调用历史
您可以在调用历史页签查看在线试用 OpenAPI 的调用历史,支持查看历史调用参数、重新调试。如果历史调用状态为失败,还可以使用诊断功能,诊断调用失败原因。
错误码
错误码页签整理了在调用OpenAPI过程中可能会出现的错误以及与之相关的错误信息描述,还提供诊断功能,一键跳转到问题诊断页面,以便进一步获取解决该特定错误的帮助文档、论坛讨论或是技术支持。
评论 (0)