Découvrez comment déboguer les opérations d'API Alibaba Cloud en ligne dans OpenAPI Explorer.
Créer un compte Alibaba Cloud
Les appels d'API nécessitent un compte Alibaba Cloud. Si vous n'en possédez pas, inscrivez-vous sur le site web officiel d'Alibaba Cloud.
Activer les services Alibaba Cloud
Activez les services Alibaba Cloud que vous souhaitez utiliser. L'exemple suivant utilise SMS :
Accédez au User Center, recherchez Short Message Service et cliquez sur Activate.
Accédez à la console du service, telle que la console SMS, et cliquez sur Activate.
Vous devez activer un service Alibaba Cloud avant d'appeler ses opérations d'API.
Déboguer une opération d'API en ligne
Connectez-vous à OpenAPI Explorer, sélectionnez un service Alibaba Cloud activé, tel qu'ECS, puis cliquez sur Debug.
Sélectionnez l'opération d'API à déboguer, par exemple DescribeInstanceTypeFamilies pour ECS. Dans la section Parameters, saisissez les valeurs comme indiqué dans l'onglet Document, puis cliquez sur Initiate Call. Débogage en ligne d'OpenAPI.
Réponse
L'onglet Response affiche le HTTP status code ainsi que les données renvoyées par l'appel.
Cet onglet affiche également les informations Request Header et Response Header.
Appel réussi
Un appel réussi renvoie le code d'état HTTP 200 avec une réponse JSON. Chaque paramètre est décrit dans la documentation de l'API, comme la référence DescribeInstanceTypeFamilies.
Échec de l'appel
Un appel échoué renvoie un code d'état HTTP dans la plage 4xx. Les API Alibaba Cloud utilisent une structure de réponse d'erreur unifiée, à l'exception de quelques services qui n'utilisent pas la passerelle standard. L'exemple suivant montre le format d'erreur pour l'opération RunInstances d'ECS :
{
"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"
}|
Paramètre |
Description |
|
RequestId |
ID de requête unique global. Fournissez ce |
|
HostId |
Endpoint du service où l'erreur s'est produite. Dans cet exemple, il s'agit de l'endpoint ECS dans la région Chine (Hangzhou). |
|
Code |
Identifiant court du type d'erreur. Recherchez ce code dans la documentation Alibaba Cloud pour trouver des solutions. Dans cet exemple, l'endpoint ne prend pas en charge la région cible. |
|
Message |
Message d'erreur détaillé. Dans cet exemple, l'endpoint ne prend pas en charge la région sélectionnée. Utilisez l'API |
|
Recommend |
URL de diagnostic. Ouvrez ce lien pour accéder à OpenAPI Troubleshoot afin d'obtenir des solutions. |
Pour résoudre les erreurs, utilisez OpenAPI Troubleshoot.
Exemple de code SDK
Dans l'onglet SDK sample code, sélectionnez une SDK version et une langue, puis cliquez sur Run Example.
Vous pouvez également cliquer sur View Version Differences pour comparer les versions du SDK, sur Download Full Project pour télécharger le code, ou basculer Generate Example in Common Mode pour changer le mode de génération.
Exemple CLI
Historique des appels
L'onglet Call History répertorie vos précédents appels d'API. Consultez les paramètres et cliquez sur Redebug pour relancer un appel. Si le status d'un appel indique un échec, utilisez Diagnose pour identifier la cause.
Dans l'onglet CLI example, cliquez sur le bouton d'exécution pour déboguer la commande en ligne.
Codes d'erreur
L'onglet Error Codes répertorie les erreurs potentielles et leurs descriptions. Cliquez sur Diagnose pour ouvrir la page de diagnostic, qui fournit des documents pertinents, des discussions de forum et une assistance.
Par exemple, la saisie d'un RegionId invalide renvoie le code d'état HTTP 404, le code d'erreur InvalidRegionId.NotFound et le message The RegionId provided does not exist in our records..