Si vous rencontrez une erreur lors de l'appel d'une opération d'API, copiez le message d'erreur dans la page OpenAPI Troubleshoot pour trouver une solution.
Obtenir un message d'erreur
À partir de la page de débogage d'OpenAPI Explorer
À partir d'un appel SDK
À partir de la CLI
À partir de Terraform
À partir d'Alibaba Cloud Developer Toolkit
Diagnostiquer les erreurs d'API
Pour interroger les messages d'erreur sur différents comptes Alibaba Cloud ou pour différents utilisateurs RAM au sein du même compte, vous devez d'abord obtenir l'autorisation nécessaire. Pour plus d'informations, consultez Autorisations pour le diagnostic d'erreurs d'API intercomptes.
Une fois que vous avez obtenu le message d'erreur, vous pouvez copier la réponse d'erreur JSON complète ou uniquement la valeur du paramètre RequestId, Code ou Message dans la page OpenAPI TroubleshootOpenAPI Troubleshoot pour trouver une solution.
Par exemple, le résultat suivant est renvoyé lorsque vous appelez l'opération RunInstances d'Elastic Compute Service (ECS) :
{
"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"
}La liste suivante décrit les paramètres :
RequestId : identifiant de la requête. Vous pouvez copier l'identifiant de la requête dans la page OpenAPI Troubleshoot pour obtenir une solution.
HostId : identifiant de l'hôte du serveur.
Code : code d'erreur.
Message : message d'erreur détaillé. Utilisez ce message pour résoudre les problèmes liés aux paramètres de requête. Dans cet exemple, il indique que l'ImageId fourni n'est pas valide. Pour résoudre l'erreur, utilisez un ID d'image valide.
Recommend : lien direct vers la page de diagnostic d'erreurs pour ce problème spécifique.
Dans certains scénarios, comme l'utilisation d'un SDK, il se peut que vous n'obteniez pas la réponse d'erreur JSON complète. Vous pouvez toujours diagnostiquer le problème en copiant uniquement la valeur du paramètre RequestId, Code ou Message dans la page OpenAPI TroubleshootOpenAPI Troubleshoot . L'utilisation de RequestId est recommandée pour obtenir les résultats les plus précis.
La figure suivante montre comment utiliser l'identifiant de la requête pour obtenir une solution de diagnostic.
Consulter la solution de diagnostic
La page OpenAPI Troubleshoot contient les onglets Diagnostic Solution et Log Information. L'onglet Diagnostic Solution affiche la solution correspondante à une erreur. Dans cet exemple, la solution suivante est fournie pour le message d'erreur The specified ImageId does not exist. :
The specified image does not exist under this user account. Check whether the image ID is correct.Sur la base de cette solution, vous devez vérifier que le paramètre ImageId de votre requête est correct.
Examiner les journaux et les détails de la requête
Si vous n'avez pas enregistré le corps de la requête d'origine, vous pouvez récupérer les paramètres de requête, la réponse et d'autres informations depuis la page OpenAPI Troubleshoot .
En utilisant l'request ID « 6BE56E05-XXXX-XXXX-XXXX-FD90C4FFD581 » comme exemple, ouvrez l'onglet Log Information. Cet onglet fournit une analyse visuelle de la trace d'appel d'API, la réponse d'erreur complète et le contenu de la requête d'origine. Ces informations vous aident à identifier et à résoudre le problème.
