Problembehandlung der API
Wenn Sie Probleme mit der API oder mit der Megaport Terraform-Lösung haben, gehen Sie die folgenden Schritte zur Problembehandlung durch.
API-Tutorials und eine schrittweise Anleitung finden Sie unter API-Übersicht. Eine vollständige Referenz, einschließlich Verwendungsbeispielen, finden Sie unter https://dev.megaport.com/.
Um die API zu testen, empfehlen wir den Postman-Client mit der importierten Megaport Collection. Informationen zum Herunterladen und Verwenden von Postman finden Sie in der Dokumentation.
Maßnahmen zur Fehlerbehebung
| Aktion | Schritte |
|---|---|
| Sicherstellen, dass das API-Zugriffstoken gültig ist | Megaport-API-Aufrufe erfordern ein Access Token, das Sie nach dem Erstellen eines API-Schlüssels generieren können. Ein Zugriffstoken ist für die Authentifizierung von API-Benutzern erforderlich und ermöglicht den zeitlich begrenzten Zugriff auf exakt die benötigten Teile des Megaport Portal. Zugriffstoken laufen nach maximal 24 Stunden ab. Danach müssen Sie ein neues Zugriffstoken generieren. Weitere Informationen dazu finden Sie unter Erstellen eines API-Schlüssels. |
| API-Umgebung (URL) überprüfen | Überprüfen Sie, ob die von Ihnen verwendeten URLs für die vorgesehene Umgebung bestimmt sind.
|
| API-Parameter überprüfen | Die Megaport-API verwendet standardmäßige HTTP-Antwortcodes. Im Allgemeinen wird ein „400 - Bad Request“-Fehler durch fehlende oder falsche Parameter verursacht. Wenn Sie diesen Fehler erhalten, überprüfen Sie noch einmal alle Ihre Parameter. |
| Überprüfen, ob die API-Syntax korrekt ist | Die korrekte Syntax ist bei der Interaktion mit der Megaport-API unerlässlich. Die Megaport-API basiert auf REST, hat vorhersehbare URLs und akzeptiert formularcodierten Anfragetext (Request Body). Beispiele für korrekte Aufrufe finden Sie unter https://dev.megaport.com. Wählen Sie im Dropdown-Menü auf dieser Seite Ihre bevorzugte Sprache aus. Es stehen Beispiele zur Verfügung, wie Sie alles innerhalb der API-Umgebung ausführen können. |
| API-Grenzwerte | Allgemeines Übertragungsratenlimit Es gibt eine Begrenzung von 500 Anfragen in einem rollierenden Zeitraum von 5 Minuten pro IP-Adresse. Dienstaktualisierungen Sie können nur alle 5 Minuten eine Dienstaktualisierung vornehmen, und es gibt eine Begrenzung von maximal 100 Aktualisierungen pro Monat und Dienst. Hinweis: Gegenwärtig handelt es sich nicht um feste Grenzwerte, aber Megaport überwacht die Grenzwerte und überprüft die Ursachen, wenn die Grenzwerte überschritten werden. Die Verletzung der Grenzwerte kann zur Sperrung des Zugangs führen. |
Allgemeine API-Fehlermeldungen
Login-Fehler
"message": "Bad session token - try logging in again." (Falsches Sitzungstoken - Anmeldung noch einmal versuchen)
Häufige Ursachen:
- Benutzername, E-Mail oder Passwort fehlerhaft
- fehlendes oder falsches Token
Syntax-Fehler
HTTP Status 400 – Bad Request
Der Fehler tritt in der Regel auf, wenn eine erforderliche Syntax fehlt oder fehlerhaft ist.
Fehlerhafte API-URL
Folgender Fehler kann im Zusammenhang mit einer fehlerhaften URL auftreten:
“message”:” Service abcd1234 has wrong product type VXC” (Dienst abcd1234 hat falschen Produkttyp-VXC)
In diesem Szenario hat der Kunde folgende URL verwendet:
URL = "https://api-staging.megaport.com/v2/product/megaport/abcd1234-1234-1234-1234-abcdef123456/telemetry?from=1614283800000&to=1614284400000&type=BITS"
Aber die korrekte URL lautet:
URL = "https://api-staging.megaport.com/v2/product/vxc/abcd1234-1234-1234-1234-abcdef123456/telemetry?type=A_BITS&from=1614283800000&to=1614284400000"
Fehlerhafte Parameter
Beispiel: Ein Kunde meldet, dass bei Anforderung von VXC-Telemetrie für folgenden Zeitbereich keine Datenausgabe erfolgt ist:
- From: GMT: Tuesday, August 3, 2021 1:52:23 PM
- To: 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”:[ ]}
Nach der Get VXC Telemetry-Dokumentation müssen die „From“- und „To“-Parameter für jeden Epochenwert in Millisekunden angegeben werden (daher benötigt jeder Wert zusätzliche Nullen am Ende):
https://api-staging.megaport.com/v2/product/vxc/abcd1234-1234-0000000000telemetry?type=A_BITS&from=1627998743000&to=1627999043000
Von Megaport benötigte Daten
Wenn die Maßnahmen zur Problembehandlung Ihr Problem nicht beheben, wenden Sie sich an den Megaport-Support. Bei einem API-Problem untersucht und behebt Megaport das Problem am Backend.
Um die Untersuchung zu unterstützen, stellen Sie die Ergebnisse der von Ihnen durchgeführten Tests und andere relevante Informationen bereit, wie z. B.:
- Verwendete E-Mail/verwendetes Konto
- Datum, Uhrzeit und Zeitzone der Aktion und wann der Fehler aufgetreten ist
- API-Konfiguration
- API-URL
- Daten im Text (Body)
- Endpunkt-Parameter und Syntax
- Fehlertyp und Screenshot des Fehlers