文档

在线调试OpenAPI

更新时间:

阿里云 OpenAPI 是阿里云提供的强大工具集,允许开发者通过编程方式管理和调用阿里云的各项服务,如 ECS(弹性计算服务)、OSS(对象存储服务)、SMS(短信服务)等。本文旨在引导您从零开始,掌握如何在线调试阿里云 OpenAPI。

注册阿里云账号

调用OpenAPI,您需要拥有一个阿里云账号。如果您还没有账号,请访问阿里云官网注册。

开通云产品服务

您可以通过以下两种方式开通您所需要的云产品服务,例如开通短信服务:

  • 可访问开通助手一键开通云产品服务。搜索短信服务,选中短信服务,单击一键开通。

  • 访问各云产品控制台,点击开通。例如在短信服务控制台单击开通。

重要

只有开通了云产品服务,才能调用该云产品的OpenAPI。

在线调试 API

登录阿里云OpenAPI门户,选择您已开通服务的云产品(例如云服务器ECS),点击去调试

image

在调试页面,选择您想要调试的API,例如调试云服务器的DescribeInstanceTypeFamilies接口,可参阅API文档后,在参数配置区域填写符合要求的参数,单击发起调用。更多详细内容请参阅API 在线调试

image

调用结果

发起调用之后,可在右侧查看调用结果。调用结果页签中可以查看接口返回的状态码和接口返回的数据。

image

调用成功

API 调用结果的状态码一般为200。返回的数据结构一般是 JSON 格式,其中各业务响应字段的含义可通过 API 文档查看,例如云服务器的 DescribeInstanceTypeFamilies API 的响应参数文档如下。

image

调用报错

API 响应结果的状态码一般为4xx。阿里云 OpenAPI 报错有统一的错误响应结构(除个别非统一网关产品),例如调用云服务器 ECS 的 RunInstances 接口,报错格式如下:

{
  "RequestId": "7DC0013A-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
  "Message": "The specified endpoint cant operate this region. Please use API DescribeRegions to get the appropriate endpoint, or upgrade your SDK to latest version.(from POP)",
  "Recommend": "https://api.aliyun.com/troubleshoot?q=InvalidOperation.NotSupportedEndpoint&product=Ecs&requestId=7DC0013A-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
  "HostId": "ecs-cn-hangzhou.aliyuncs.com",
  "Code": "InvalidOperation.NotSupportedEndpoint"
}

参数名

参数说明

RequestId

全局唯一的请求标识符,用于追踪和识别特定的API调用。当你需要联系阿里云客服解决问题时,提供这个RequestId可以帮助他们更快地定位问题发生的上下文。

HostId

服务端主机标识。表示产生错误的主机标识或服务端点地址。在这个例子中,错误来源于阿里云ECS( Elastic Compute Service)服务的杭州区域终端节点。

Code

错误码。是对错误类型的简短、精确描述,开发者可以通过这个错误码在阿里云的文档中查找具体的错误含义和解决方案。在这个案例中,错误码表明了所尝试的操作因为使用的终端节点不支持目标区域而无效。

Message

详细错误信息。在这个例子中,错误是因为使用的终端节点(endpoint)不支持操作指定的区域。阿里云建议使用DescribeRegions API获取正确的终端节点。

Recommend

错误诊断链接,可直接复制该链接跳转到错误诊断页面,可以获取更多的解决方案。

关于异常排查更多信息,请参阅API 报错诊断

SDK 示例

支持在SDK 示例页签,选择SDK 版本,选择SDK 语言,单击运行示例调试。

image

CLI 示例

支持在CLI 示例页签,单击右侧运行命令按钮进行在线调试。

image

调用历史

您可以在调用历史页签查看在线试用 OpenAPI 的调用历史,支持查看历史调用参数、重新调试。如果历史调用状态为失败,还可以使用诊断功能,诊断调用失败原因。

image

错误码

错误码页签整理了在调用OpenAPI过程中可能会出现的错误以及与之相关的错误信息描述,还提供诊断功能,一键跳转到问题诊断页面,以便进一步获取解决该特定错误的帮助文档、论坛讨论或是技术支持。

image

  • 本页导读 (1)