Dépannage de l’API
Si vous rencontrez des problèmes avec l’API ou avec la solution Megaport Terraform, procédez aux actions de dépannage suivantes.
Pour des tutoriels sur l’API et un guide pas à pas, voir Présentation de l’API. Pour une référence complète, y compris des exemples de travail, voir https://dev.megaport.com/.
Pour tester l’API, nous recommandons le client Postman avec la collection Megaport importée. Vous trouverez des informations sur le téléchargement et l’utilisation de Postman dans la documentation.
Actions de dépannage
| Action | Étapes |
|---|---|
| Assurez-vous que le jeton d’accès API est valide | Les appels API 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 authentifier les utilisateurs de l’API et fournit un accès temporaire aux parties nécessaires du portail Megaport uniquement. 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, voir Création d’une clé API. |
| Vérifiez que l’environnement de l’API (URL) est correct | Vérifiez que les URL que vous utilisez correspondent à l’environnement prévu.
|
| S’assurer que les paramètres API sont corrects | L’API Megaport utilise des codes de réponse HTTP standard. D’une manière générale, une erreur 400 - Bad Request est typiquement causée par des paramètres manquants ou incorrects. Si vous recevez cette erreur, vérifiez à nouveau vos paramètres. |
| Assurez-vous que la syntaxe de votre API est correcte | La syntaxe correcte est essentielle lors de l’interaction avec l’API Megaport. L’API Megaport est basée sur REST, possède des URL prévisibles et accepte les corps de demande codés par 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 pourrez voir des exemples de ce que vous pouvez faire dans l’environnement API. |
| Limites de l’API | Limite générale du débit Le débit est limité à 500 demandes par adresse IP sur une période continue de 5 minutes. Mises à jour du service Vous ne pouvez effectuer qu’une mise à jour du service toutes les 5 minutes, et il y a un maximum de 100 mises à jour par mois et par service. Remarque : Actuellement, il ne s’agit pas de limites strictes, mais Megaport surveille et examine les cas où les limites sont dépassées. En cas de violation des limites, l’accès pourrait être bloqué. |
Messages d’erreur courants de l’API
Erreur de connexion
"message" : "Mauvais jeton de session - essayez de vous reconnecter."
Causes communes :
- nom d’utilisateur, adresse électronique ou mot de passe incorrect
- jeton manquant ou incorrect
Erreur de syntaxe
Statut HTTP 400 - mauvaise requête
Cette erreur se produit généralement lorsqu’une syntaxe requise est manquante ou incorrecte.
URL de l’API incorrecte
Voici un exemple d’erreur liée à une URL incorrecte :
"message" :" Le service abcd1234 n'a pas le bon type de produit VXC".
Pour 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 correct 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’il n’y avait aucune sortie de données lorsqu’il a demandé la télémétrie du VXC pour cette plage horaire :
- De : GMT : Mardi, août 3, 2021 1:52:23 PM
- A : GMT : Mardi, août 3, 2021, 1:57:23 PM
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”:[ ]}
D’après la documentation Get VXC Telemetry, les paramètres From et To doivent être définis en millisecondes pour chaque valeur d’époque (il faut donc ajouter des zéros à la fin de chaque valeur) :
https://api-staging.megaport.com/v2/product/vxc/abcd1234-1234-0000000000telemetry?type=A_BITS&from=1627998743000&to=1627999043000
Données requises pour le Megaport
Si les actions de dépannage ne résolvent pas votre problème, contactez le support Megaport. Dans le cas d’un problème d’API, Megaport examine et résout le problème au niveau du back-end.
Pour aider l’enquête, fournissez les résultats des tests que vous avez effectués et toute autre information pertinente, comme par exemple :
- Courriel/compte utilisé
- Date, heure et fuseau horaire de l’action et du moment où l’erreur s’est produite
- Configuration de l’API
- URL DE L’API
- Données du corps
- Paramètres et syntaxe des points de terminaison
- Type d’erreur et une capture d’écran de l’erreur