阿里云OpenAPI开发者门户

使用指南

简介

阿里云 OpenAPI 开发者门户(以下简称门户) OpenAPI 开放元数据,是阿里云 OpenAPI 的描述规范。

您可以通过门户开放元数据,定制生成不同编程语言的 SDK ,也可以编写 IDE 插件等集成阿里云 OpenAPI 的相关工具。门户自身的 API 调试、文档渲染等能力,同样基于开放元数据构建。

您可以通过调用如下 OpenAPI,获取阿里云对应产品及 OpenAPI 的开放元数据。开放元数据 API 皆无需鉴权,可在公网环境下自由调用。

  • GetProductList 获取 OpenAPI 开发者门户的产品及日期版本列表
  • GetApiOverview 获取指定产品和日期版本下的开放元数据概要信息
  • GetApiInfo 获取指定 OpenAPI 的开放元数据
  • GetAPIDocs 获取指定产品和日期版本下的所有开放元数据

阿里云开发者门户 OpenAPI 开放元数据,在参照 OAS2JSONSchema 标准的同时,也由于阿里云 OpenAPI 自身的特点做了局部的调整。您可以查看 ApiDocs 了解阿里云 OpenAPI 元数据的结构信息。

开放元数据示例

  • ECS 开放元数据

请求地址:https://api.aliyun.com/meta/v1/products/Ecs/versions/2014-05-26/api-docs.json

获取国际站的 OpenAPI 开放元数据

在门户国际站域名下请求开放元数据,即可获取国际站的 OpenAPI 开放元数据。

例如,您可以请求 https://api.alibabacloud.com/meta/v1/products.json 来获取门户国际站支持的产品列表。

获取英文版的 OpenAPI 开放元数据

在开放元数据 API 中,添加 language=EN_US 的 query 参数即可获取英文版的开放元数据。

例如,您可以请求 https://api.aliyun.com/meta/v1/products/Ecs/versions/2014-05-26/api-docs.json?language=EN_US 获取 ECS 的 2014-05-26 版本下的所有开放元数据。

2024年08月20日