Dépannage de l’API
Si vous rencontrez des problèmes avec l’API ou avec la solution Terraform de Megaport, suivez ces actions de dépannage.
Pour des tutoriels sur l’API et un guide étape par étape, consultez Aperçu de l’API Megaport. Pour une référence complète, y compris des exemples fonctionnels, consultez https://dev.megaport.com/.
Pour essayer l’API, nous recommandons le client Postman avec la Collection Megaport importée ; des informations sur le téléchargement et l’utilisation de Postman se trouvent dans la documentation.
Actions de dépannage
| Action | Étapes |
|---|---|
| Assurez-vous que le jeton d’accès API est valide | Les appels API de Megaport nécessitent un jeton d’accès que vous pouvez générer après avoir créé une clé API. Un jeton d’accès est requis pour l’authentification des utilisateurs de l’API, et permet un accès temporaire uniquement aux parties du Megaport Portal qui sont nécessaires. Les jetons d’accès expirent après un maximum de 24 heures, après quoi vous devez générer un nouveau jeton d’accès. Pour plus d’informations, consultez Création d’une clé API. |
| Assurez-vous que l’environnement API (URL) est correct | Assurez-vous que les URLs que vous utilisez correspondent à l’environnement voulu.
|
| Assurez-vous que les paramètres API sont corrects | L’API Megaport utilise des codes de réponse HTTP standards. En général, une erreur 400 - Bad Request est typiquement causée par des paramètres manquants ou incorrects. Si vous recevez cette erreur, vérifiez vos paramètres. |
| Assurez-vous que votre syntaxe API est correcte | La syntaxe correcte est essentielle lors de l’interaction avec l’API Megaport. L’API Megaport est basée sur REST, a des URLs prévisibles, et accepte les corps de requête encodés en formulaire. Vous pouvez voir des exemples d’appels corrects sur https://dev.megaport.com. Sélectionnez votre langue préférée dans le menu déroulant de cette page, et vous pouvez voir des exemples de comment effectuer des actions dans l’environnement API. |
| Limites de l’API | Limite Générale de Taux Il existe une limite de taux de 500 requêtes sur une période de 5 minutes glissantes par adresse IP. Mises à jour de service Vous ne pouvez effectuer qu’une mise à jour de service toutes les 5 minutes, et il y a un maximum de 100 mises à jour par mois et par service. Note: Actuellement, ces limites ne sont pas strictes, mais Megaport surveille et revoit lorsque les limites sont dépassées. Si des dépassements de limites surviennent, l’accès pourrait être bloqué. |
Messages d’erreur courants de l’API
Erreur de connexion
"message": "Bad session token - try logging in again."
Causes courantes:
- nom d’utilisateur, email ou mot de passe incorrect
- jeton manquant ou incorrect
Erreur de syntaxe
HTTP Status 400 – Bad Request
L’erreur survient généralement lorsque la syntaxe requise est manquante ou incorrecte.
URL de l’API incorrecte
Un exemple d’erreur liée à l’URL incorrecte est:
“message”:” Service abcd1234 has wrong product type VXC”
Dans ce scénario, le client a utilisé cette URL:
URL = "https://api-staging.megaport.com/v2/product/megaport/abcd1234-1234-1234-1234-abcdef123456/telemetry?from=1614283800000&to=1614284400000&type=BITS"
mais l’URL correcte est:
URL = "https://api-staging.megaport.com/v2/product/vxc/abcd1234-1234-1234-1234-abcdef123456/telemetry?type=A_BITS&from=1614283800000&to=1614284400000"
Paramètres incorrects
Par exemple, un client a signalé qu’aucune donnée n’était renvoyée lors de la demande de télémétrie VXC pour cet intervalle de temps:
- De: GMT: Mardi 3 août 2021 13:52:23
- À: GMT: Mardi 3 août 2021, 13:57:23
Syntaxe
https://api-staging.megaport.com/v2/product/vxc/abcd1234-1234-0000000000telemetry?type=A_BITS&from=1627998743&to=1627999043
Sortie
{“serviceUid”:”abcd1234-1234-0000000000”,”type”:”A_BITS”,”timeFrame”:{“from”:1627998743,”to:”1627999043},”data”:[ ]}
Selon les docs Obtenir la télémétrie VXC les paramètres From et To doivent être définis en millisecondes pour chaque valeur d’époque (donc chaque valeur avait besoin de zéros supplémentaires à la fin).
https://api-staging.megaport.com/v2/product/vxc/abcd1234-1234-0000000000telemetry?type=A_BITS&from=1627998743000&to=1627999043000
Données requises par Megaport
Si les actions de dépannage ne résolvent pas votre problème, contactez le Support de Megaport. Avec un problème d’API, Megaport enquêtera et résoudra le problème en arrière-plan.
Pour aider à l’enquête, fournissez les résultats des tests que vous avez effectués et toute autre information pertinente, telle que:
- Email/compte utilisé
- Date, heure et fuseau horaire de l’action et lorsque l’erreur s’est produite
- Configuration de l’API
- URL de l’API
- Données du corps
- Paramètres et syntaxe de l’endpoint
- Type d’erreur et capture d’écran de l’erreur