Solución de problemas de la API
Si encuentra problemas con la API o con la solución de Terraform de Megaport, siga estas acciones de solución de problemas.
Para tutoriales de la API y una guía paso a paso, consulte Megaport Descripción general de la API. Para una referencia completa, incluidos ejemplos funcionales, consulte https://dev.megaport.com/.
Para probar la API, recomendamos el cliente Postman con la Colección de Megaport importada; la información sobre cómo descargar y usar Postman está en la documentación.
Acciones de solución de problemas
| Acción | Pasos |
|---|---|
| Asegúrese de que el token de acceso de la API sea válido | Las llamadas a la API de Megaport requieren un token de acceso que puede generar después de crear una clave de API. Se requiere un token de acceso para autenticar a los usuarios de la API y permite acceso temporal solo a las partes de Megaport Portal que se requieren. Los tokens de acceso caducan después de un máximo de 24 horas, tras lo cual debe generar un nuevo token de acceso. Para obtener más información, consulte Creación de una clave de API. |
| Asegúrese de que el entorno de la API (URL) sea correcto | Asegúrese de que las URL que está usando correspondan al entorno previsto.
|
| Asegúrese de que los parámetros de la API sean correctos | La API de Megaport utiliza códigos de respuesta HTTP estándar. En general, un error 400 - Bad Request suele estar causado por parámetros faltantes o incorrectos. Si está recibiendo este error, vuelva a comprobar sus parámetros. |
| Asegúrese de que la sintaxis de su API sea correcta | La sintaxis correcta es esencial al interactuar con la API de Megaport. La API de Megaport se basa en REST, tiene URL predecibles y acepta cuerpos de solicitud codificados como formulario. Puede ver ejemplos de las llamadas correctas en https://dev.megaport.com. Seleccione su idioma preferido en el menú desplegable de esta página para ver ejemplos de cómo hacer cualquier cosa dentro del entorno de la API. |
| Límites de la API | Límite general de solicitudes Existe un límite de 500 solicitudes en un período móvil de 5 minutos por dirección IP. Actualizaciones de servicio Solo puede realizar una actualización de servicio cada 5 minutos, y hay un máximo de 100 actualizaciones por mes por servicio. Nota: Actualmente, estos no son límites estrictos, pero Megaport supervisa y revisa cuando se exceden. Si se producen incumplimientos de los límites, se podría bloquear el acceso. |
Mensajes de error comunes de la API
Error de inicio de sesión
"message": "Bad session token - try logging in again."
Causas comunes:
- nombre de usuario, correo electrónico o contraseña incorrectos
- token faltante o incorrecto
Error de sintaxis
HTTP Status 400 – Bad Request
Este error suele ocurrir cuando falta una sintaxis requerida o es incorrecta.
URL de la API incorrecta
Un ejemplo del error relacionado con una URL incorrecta es:
“message”:” Service abcd1234 has wrong product type VXC”
Para este escenario, el cliente usó esta URL:
URL = "https://api-staging.megaport.com/v2/product/megaport/abcd1234-1234-1234-1234-abcdef123456/telemetry?from=1614283800000&to=1614284400000&type=BITS"
pero la URL correcta es:
URL = "https://api-staging.megaport.com/v2/product/vxc/abcd1234-1234-1234-1234-abcdef123456/telemetry?type=A_BITS&from=1614283800000&to=1614284400000"
Parámetros incorrectos
Como ejemplo, un cliente informó que no había salida de datos al solicitar telemetría de VXC para este intervalo de tiempo:
- Desde: GMT: martes, 3 de agosto de 2021 1:52:23 PM
- Hasta: GMT: martes, 3 de agosto de 2021, 1:57:23 PM
Sintaxis
https://api-staging.megaport.com/v2/product/vxc/abcd1234-1234-0000000000telemetry?type=A_BITS&from=1627998743&to=1627999043
Salida
{“serviceUid”:”abcd1234-1234-0000000000”,”type”:”A_BITS”,”timeFrame”:{“from”:1627998743,”to:”1627999043},”data”:[ ]}
Según la Get VXC Telemetry docs, los parámetros From y To deben establecerse en milisegundos para cada valor de epoch (por lo que cada valor necesitaba ceros adicionales al final):
https://api-staging.megaport.com/v2/product/vxc/abcd1234-1234-0000000000telemetry?type=A_BITS&from=1627998743000&to=1627999043000
Datos requeridos por Megaport
Si las acciones de solución de problemas no resuelven su problema, comuníquese con el Soporte de Megaport. Con un problema de API, Megaport investigará y solucionará el problema en el back-end.
Para ayudar en la investigación, proporcione los resultados de las pruebas que realizó y cualquier otra información relevante, como:
- Correo electrónico/cuenta usados
- Fecha, hora y zona horaria de la acción y cuándo ocurrió el error
- Configuración de la API
- URL de la API
- Datos del cuerpo
- Parámetros del endpoint y sintaxis
- Tipo de error y una captura de pantalla del error