:Utilisation d'OpenAPI

Cette rubrique explique comment appeler les opérations d'API.

En tant que développeur, tenez compte des éléments suivants lors de l'appel d'opérations d'API :

1. Adresse d'appel

2. Connexion requise ou non

3. Autorisation requise ou non

4. Méthode d'appel

5. Résultat renvoyé

Le processus est identique à celui des APIs d'Alibaba Cloud.

Diagramme de séquence d'un appel d'opération d'API Alibaba Cloud

Le diagramme ci-dessous illustre la séquence complète des événements, depuis l'envoi d'une requête d'API par le client jusqu'à la réception de la réponse du service Alibaba Cloud.

1. L'utilisateur envoie une requête HTTP pour appeler l'opération fournie par le serveur métier. Par exemple, la requête permet d'interroger l'état d'une instance Elastic Compute Service (ECS).

2. Le serveur métier reçoit la requête du client métier et vérifie la validité des paramètres. Il organise les paramètres conformément à la documentation de l'API et signe la requête. Si un SDK Alibaba Cloud est utilisé pour appeler les opérations d'API, le serveur métier n'a pas besoin de signer la requête, car le SDK intègre déjà la logique de signature.

3. Le serveur métier envoie une requête à l'endpoint de la passerelle d'API.

4. La passerelle d'API reçoit la requête du serveur métier, vérifie la signature, identifie l'appelant et procède à l'authentification.

5. Une fois l'authentification réussie, la requête est transférée vers l'adresse du service interne.

6. Le produit cloud reçoit la requête de la passerelle, exécute les opérations sur les ressources cloud spécifiées et renvoie le résultat.

7. La passerelle d'API reçoit les données renvoyées par le produit cloud, les convertit au format de sortie standard et les retourne au serveur métier.

8. Le serveur métier reçoit les données renvoyées par la passerelle d'API, traite les résultats et les renvoie au client métier.

Termes

Endpoint

Un endpoint est une adresse de service enregistrée dans la passerelle, permettant aux clients d'accéder à un produit cloud. Il s'agit d'une URL qui spécifie le protocole d'accès, le nom d'hôte, le port et le chemin d'accès du service. Les utilisateurs peuvent utiliser ces informations pour communiquer avec le service cloud.

Identité, identifiants et authentification

Les APIs d'Alibaba Cloud sont classées en deux types : les APIs anonymes et les APIs authentifiées. Pour appeler une API anonyme, assurez-vous simplement que votre requête respecte le style de l'API. Aucune authentification n'est requise.

Pour appeler une API authentifiée, la passerelle doit vérifier les identifiants de la requête afin de confirmer l'identité de l'appelant. Elle ne transmet la requête au service cloud qu'après validation des autorisations.

Méthode d'appel

Alibaba Cloud propose plusieurs méthodes pour appeler les opérations d'API, notamment les SDK Alibaba Cloud, l'interface CLI Alibaba Cloud et Resource Orchestration Service (ROS). Vous pouvez également implémenter vos propres requêtes HTTP.