L'auto-signature des requêtes API Alibaba Cloud requiert des métadonnées telles que le style d'API, les protocoles pris en charge et la définition des paramètres. Cette rubrique explique comment consulter et récupérer ces informations.
Présentation des métadonnées des produits cloud
Les métadonnées OpenAPI regroupent les informations descriptives des API d'un produit cloud. Lors de la signature, extrayez-en le style d'API, les protocoles pris en charge, les méthodes de requête, ainsi que le nom, le type et l'emplacement des paramètres.
Présentation du produit et de la version (Info)
Cette section indique le style d'API, le code du produit et la version.
Exemple :
{"style":"RPC","product":"Ecs","version":"2014-05-26"}
Collection des résumés d'API (apis)
Map indexée par nom d'API. Chaque valeur correspond à un résumé d'API contenant les paramètres suivants :
|
Nom du paramètre |
Description |
Exemple |
|
methods |
Méthodes de requête prises en charge. |
POST et GET renvoient des résultats identiques. |
|
schemes |
Protocoles pris en charge. |
HTTP et HTTPS sont tous deux pris en charge. |
|
parameters |
Paramètres de requête. |
Indique le nom, l'emplacement (query, path ou body), le type et le caractère obligatoire de chaque paramètre. |
Collection des endpoints (endpoints)
Endpoints de service du produit cloud.
Obtention des métadonnées
Méthode 1 : Obtenir les métadonnées d'un produit cloud
Sur la page ou Documentation API, sélectionnez un produit cloud tel que Elastic Compute Service (ECS), puis cliquez sur Get Metadata sous le nom du produit.
Méthode 2 : Obtenir les métadonnées d'une API spécifique
Sur la page ou Documentation API, sélectionnez un produit cloud comme ECS, choisissez l'API cible, puis cliquez sur Get Metadata dans le coin supérieur droit.
Méthode 3 : Appeler l'API de métadonnées
L'API de métadonnées est accessible publiquement sans authentification. Utilisez les endpoints suivants pour récupérer les métadonnées. Consultez le ou le Guide d'utilisation des métadonnées pour obtenir la référence complète de l'API.
|
Description de l'API |
URL de l'API |
Méthode de requête |
|
Lister tous les codes et versions des produits cloud |
https://api.aliyun.com/meta/v1/products.json?language=EN_US |
GET |
|
Obtenir les métadonnées d'un produit et d'une version spécifiques |
https://api.aliyun.com/meta/v1/products/{product}/versions/{version}/api-docs.json |
GET |
|
Obtenir les métadonnées d'une API spécifique |
https://api.aliyun.com/meta/v1/products/{product}/versions/{version}/apis/{api_name}/api.json |
GET |