action.skip

Fehlerbehebung für die API

Wenn Sie auf Probleme mit der API oder mit der Megaport Terraform-Lösung stoßen, gehen Sie diese Schritte zur Fehlerbehebung durch.

Für API-Anleitungen und eine Schritt-für-Schritt-Anleitung siehe Megaport API-Übersicht. Für eine vollständige Referenz, einschließlich funktionierender Beispiele, siehe https://dev.megaport.com/.

Zum Ausprobieren der API empfehlen wir den Postman-Client mit der importierten Megaport Collection; Informationen zum Herunterladen und zur Verwendung von Postman finden Sie in der Dokumentation.

Schritte zur Fehlerbehebung

Aktion Schritte
Sicherstellen, dass das API-Access-Token gültig ist Megaport API-Aufrufe erfordern ein Access Token, das Sie nach dem Erstellen eines API-Schlüssels generieren können. Ein Access Token ist für die Authentifizierung von API-Nutzern erforderlich und gewährt temporären Zugriff nur auf die Teile des Megaport Portal, die benötigt werden. Access Tokens laufen nach spätestens 24 Stunden ab; anschließend müssen Sie ein neues Access Token generieren. Weitere Informationen finden Sie unter Erstellen eines API-Schlüssels.
Sicherstellen, dass die API-Umgebung (URL) korrekt ist Stellen Sie sicher, dass die von Ihnen verwendeten URLs der vorgesehenen Umgebung entsprechen.
  • PRODUCTION - ​​https://api.megaport.com
    Das voll funktionsfähige Livesystem. Sie sind für alle in diesem System bestellten Services und die damit verbundenen Kosten verantwortlich.
  • STAGING - https://api-staging.megaport.com
    Ermöglicht das Testen von Befehlen ohne Auswirkungen auf Ihre Produktionsumgebung. Die Staging-Umgebung wird alle 24 Stunden mit den neuesten Produktionswerten überschrieben.
Sicherstellen, dass die API-Parameter korrekt sind Die Megaport API verwendet standardmäßige HTTP-Response-Codes. Im Allgemeinen wird ein 400 - Bad Request-Fehler typischerweise durch fehlende oder falsche Parameter verursacht. Wenn Sie diesen Fehler erhalten, überprüfen Sie Ihre Parameter noch einmal.
Sicherstellen, dass Ihre API-Syntax korrekt ist Die korrekte Syntax ist entscheidend für die Interaktion mit der Megaport API. Die Megaport API basiert auf REST, verfügt über vorhersehbare URLs und akzeptiert formularcodierte Request-Bodies.

Beispiele für korrekte Aufrufe finden Sie unter https://dev.megaport.com. Wählen Sie auf dieser Seite Ihre bevorzugte Sprache im Drop-down-Menü aus, dann sehen Sie Beispiele dafür, wie Sie Vorgänge innerhalb der API-Umgebung ausführen können.
API-Limits Allgemeines Rate Limit (Übertragungsratenlimit)
Es gilt ein Rate Limit (Übertragungsratenlimit) von 500 Requests in einem gleitenden Zeitraum von 5 Minuten pro IP-Adresse.

Service-Updates
Sie können nur alle 5 Minuten ein Service-Update durchführen, und es gibt ein Maximum von 100 Updates pro Monat und Service.

Hinweis: Derzeit sind dies keine harten Limits, aber Megaport überwacht und prüft, wenn Limits überschritten werden. Wenn Limit-Überschreitungen auftreten, kann der Zugriff blockiert werden.

Häufige API-Fehlermeldungen

Anmeldefehler

"message": "Bad session token - try logging in again."

Häufige Ursachen:

  • falscher Benutzername, falsche E-Mail-Adresse oder falsches Passwort
  • fehlendes oder falsches Token

Syntaxfehler

HTTP Status 400 – Bad Request

Dieser Fehler tritt häufig auf, wenn eine erforderliche Syntax fehlt oder falsch ist.

Falsche API-URL

Ein Beispiel für den Fehler, der mit der falschen URL zusammenhängt, ist:

“message”:” Service abcd1234 has wrong product type VXC”

In diesem Szenario hat der Kunde diese URL verwendet:

URL = "https://api-staging.megaport.com/v2/product/megaport/abcd1234-1234-1234-1234-abcdef123456/telemetry?from=1614283800000&to=1614284400000&type=BITS"

die korrekte URL ist jedoch:

URL = "https://api-staging.megaport.com/v2/product/vxc/abcd1234-1234-1234-1234-abcdef123456/telemetry?type=A_BITS&from=1614283800000&to=1614284400000"

Falsche Parameter

Beispielsweise meldete ein Kunde keine Datenausgabe beim Anfordern der VXC-Telemetrie für diesen Zeitraum:

  • Von: GMT: Tuesday, August 3, 2021 1:52:23 PM
  • Bis: GMT: Tuesday, August 3, 2021, 1:57:23 PM

Syntax

https://api-staging.megaport.com/v2/product/vxc/abcd1234-1234-0000000000telemetry?type=A_BITS&from=1627998743&to=1627999043

Ausgabe

{“serviceUid”:”abcd1234-1234-0000000000”,”type”:”A_BITS”,”timeFrame”:{“from”:1627998743,”to:”1627999043},”data”:[ ]}

In den Get VXC Telemetry docs müssen die Parameter From und To für jeden Epoch-Wert in Millisekunden angegeben werden (d. h. jeder Wert benötigt zusätzliche Nullen am Ende):

https://api-staging.megaport.com/v2/product/vxc/abcd1234-1234-0000000000telemetry?type=A_BITS&from=1627998743000&to=1627999043000

Für Megaport erforderliche Daten

Wenn die Schritte zur Fehlerbehebung Ihr Problem nicht lösen, kontaktieren Sie den Megaport Support. Bei einem API-Problem wird Megaport das Problem im Backend untersuchen und beheben.

Um die Untersuchung zu unterstützen, geben Sie die Ergebnisse der von Ihnen durchgeführten Tests und alle anderen relevanten Informationen an, zum Beispiel:

  • E-Mail/Konto verwendet
  • Datum, Uhrzeit und Zeitzone der Aktion und wann der Fehler auftrat
  • API-Konfiguration
  • API-URL
  • Body-Daten
  • Endpoint-Parameter und Syntax
  • Fehlertyp und ein Screenshot des Fehlers

Hilfreiche Referenzen