Los metadatos de API son obligatorios para firmar manualmente las solicitudes de API de Alibaba Cloud. Incluyen el estilo de API, los protocolos compatibles y las definiciones de parámetros. Aprenda a leer y obtener estos metadatos.
Descripción general de los metadatos de productos en la nube
Los metadatos de OpenAPI son el conjunto de información descriptiva de las API de un producto en la nube. Durante la firma, extraiga de estos metadatos el estilo de API, los protocolos compatibles y los métodos de solicitud. También extraiga los nombres, tipos y ubicaciones de los parámetros.
Descripción general del producto y la versión (Info)
Incluye el estilo de API, el código del producto y la versión.
Ejemplo:
{"style":"RPC","product":"Ecs","version":"2014-05-26"}
Colección de resúmenes de API (apis)
Un mapa indexado por nombre de API, donde cada valor es un resumen de API con los parámetros que se muestran a continuación:
|
Nombre del parámetro |
Descripción |
Ejemplo |
|
methods |
Métodos de solicitud compatibles. |
Tanto POST como GET devuelven resultados idénticos. |
|
schemes |
Protocolos compatibles. |
Tanto HTTP como HTTPS son compatibles. |
|
parameters |
Parámetros de solicitud. |
Describe el nombre de cada parámetro, su ubicación (query, path o body), su tipo y si es obligatorio. |
Colección de endpoints (endpoints)
Endpoints de servicio del producto en la nube.
Cómo obtener los metadatos
Método 1: obtener metadatos de productos en la nube
En la página de o documentación de API, seleccione un producto en la nube como Elastic Compute Service (ECS). Después, haga clic en Get Metadata debajo del nombre del producto.
Método 2: obtener metadatos de una API específica
En la página de o documentación de API, seleccione un producto en la nube como ECS. Después, elija la API de destino y haga clic en Get Metadata en la esquina superior derecha.
Método 3: llamar a la API de metadatos
La API de metadatos es accesible públicamente sin autenticación. Use los endpoints que se indican a continuación para obtener los metadatos. La referencia completa de la API se encuentra en la o Guía de uso de metadatos.
|
Descripción de la API |
URL de la API |
Método de solicitud |
|
Enumerar todos los códigos y las versiones de los productos en la nube |
https://api.alibabacloud.com/meta/v1/products.json?language=EN_US |
GET |
|
Obtener los metadatos de un producto y una versión específicos |
https://api.alibabacloud.com/meta/v1/products/{product}/versions/{version}/api-docs.json |
GET |
|
Obtener los metadatos de una API específica |
https://api.alibabacloud.com/meta/v1/products/{product}/versions/{version}/apis/{api_name}/api.json |
GET |