在线调试阿里云OpenAPI_OpenAPI Explorer(OpenAPI)-阿里云帮助中心

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

注册阿里云账号

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

开通云产品服务

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

可访问开通助手一键开通云产品服务。搜索短信服务，选中短信服务，单击一键开通。
访问各云产品控制台，点击开通。例如在短信服务控制台单击开通。

重要

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

在线调试 API

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

例如调试云服务器的DescribeInstanceTypeFamilies接口，可参阅API文档后，在参数配置区域填写符合要求的参数，单击发起调用，即可在右侧查看调用成功的返回结果。更多详细内容请参阅API 在线调试。

调用 API 结果

调用成功

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

调用报错

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	请求唯一标识。
HostId	服务端主机标识。
Code	错误码。
Message	详细错误信息。
Recommend	错误诊断链接，可直接复制该链接跳转到错误诊断页面获取解决方案。

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