Lorsque vous rencontrez une erreur lors de l'appel d'une API OpenAPI, copiez le message d'erreur dans la page de dépannage OpenAPI pour obtenir automatiquement une solution.
Obtenir le message d'erreur
Page de débogage en ligne de l'API
Appel via SDK
Appel via CLI
Appel via Terraform
Alibaba Cloud Developer Toolkit
Diagnostiquer les problèmes OpenAPI
Pour interroger les messages d'erreur entre différents comptes Alibaba Cloud ou entre différents utilisateurs Resource Access Management (RAM) au sein du même compte, effectuez d'abord autorisation, puis réessayez.
Après avoir obtenu le message d'erreur, copiez l'intégralité du contenu JSON ou uniquement les champs RequestId, Code ou Message dans la OpenAPI TroubleshootingOpenAPI Troubleshooting pour obtenir automatiquement une solution.
Par exemple, lors de l'appel à l'API RunInstances d'Elastic Compute Service, si vous recevez une erreur, le message d'erreur se présente comme suit :
{
"RequestId": "6BE56E05-XXXX-XXXX-XXXX-FD90C4FFD581",
"HostId": "ecs.ap-southeast-3.aliyuncs.com",
"Code": "InvalidImageId.NotFound",
"Message": "The specified ImageId does not exist.",
"Recommend": "https://api.alibabacloud.com/troubleshoot?intl_lang=EN_US&q=InvalidImageId.NotFound&product=Ecs&requestId=6BE56E05-XXXX-XXXX-XXXX-FD90C4FFD581"
}Les paramètres signifient ce qui suit :
RequestId : un identifiant unique pour la requête. Copiez cette valeur dans la OpenAPI Troubleshooting pour obtenir automatiquement une solution.
HostId : le endpoint de service pour la requête API.
Code : le code d'erreur.
Message : informations détaillées sur l'erreur. Utilisez ces informations pour vérifier vos paramètres de requête. Dans cet exemple, l'erreur survient car un ID d'image invalide a été transmis en tant que ImageId. Corrigez le problème en utilisant un ID d'image valide.
Recommend : un lien direct vers la page de diagnostic des erreurs. Copiez ce champ pour accéder directement à la solution de dépannage.
Dans des scénarios réels, par exemple lors de l'utilisation d'un SDK, il est possible que vous ne receviez pas la réponse d'erreur JSON complète. Dans ce cas, copiez uniquement le RequestId, le Code ou le Message dans la OpenAPI TroubleshootingOpenAPI Troubleshooting pour obtenir une solution. L'utilisation du RequestId donne le résultat le plus précis.
La solution récupérée à l'aide d'un RequestId s'affiche comme indiqué ci-dessous :
Consulter la solution de diagnostic
Comme illustré ci-dessus, la page affiche deux onglets en bas : Diagnosis Solution et Log Information. L'onglet Diagnosis Solution montre la solution correspondante. Par exemple, si le message d'erreur est The specified ImageId does not exist., la solution fournie est :
The specified image does not exist under this account. Check whether the image ID is correct.Suivez les instructions de la solution pour vérifier que la valeur du paramètre ImageId est correcte.
Vérifier les paramètres de requête
Dans des scénarios réels, il est possible que vous n'ayez pas enregistré le corps de la requête d'origine lorsque l'erreur s'est produite. Vous pouvez toujours utiliser OpenAPI Troubleshooting pour récupérer les paramètres de requête, la réponse et d'autres détails.
Prenons l'exemple de l'erreur avec le RequestId : 6BE56E05-XXXX-XXXX-XXXX-FD90C4FFD581. Cliquez sur l'onglet Log Information. Comme indiqué ci-dessous, vous pouvez consulter l'analyse visuelle de la chaîne d'appel, le message d'erreur complet et le contenu de la requête d'origine. Utilisez ces journaux pour identifier et résoudre le problème avec plus de précision.
