Solução de problemas da API
Se você encontrar problemas com a API ou com a solução Terraform da Megaport, siga estas ações de solução de problemas.
Para tutoriais da API e um guia passo a passo, consulte Visão geral da API da Megaport. Para uma referência completa, incluindo exemplos funcionais, consulte https://dev.megaport.com/.
Para experimentar a API, recomendamos o cliente Postman com a Collection da Megaport importada; informações sobre como baixar e usar o Postman estão na documentação.
Ações de solução de problemas
| Ação | Etapas |
|---|---|
| Verifique se o token de acesso da API é válido | As chamadas da API da Megaport exigem um token de acesso que você pode gerar após criar uma chave de API. Um token de acesso é necessário para autenticar os usuários da API e permite acesso temporário apenas às partes do Megaport Portal que são necessárias. Os tokens de acesso expiram após no máximo 24 horas, após o que você precisa gerar um novo token de acesso. Para obter mais informações, consulte Criar uma chave de API. |
| Verifique se o ambiente da API (URL) está correto | Certifique-se de que as URLs que você está usando sejam do ambiente desejado.
|
| Verifique se os parâmetros da API estão corretos | A API da Megaport usa códigos de resposta HTTP padrão. De modo geral, um erro 400 - Bad Request é normalmente causado por parâmetros ausentes ou incorretos. Se você estiver recebendo esse erro, verifique novamente seus parâmetros. |
| Verifique se a sintaxe da sua API está correta | A sintaxe correta é essencial ao interagir com a API da Megaport. A API da Megaport é baseada em REST, tem URLs previsíveis e aceita corpos de requisição codificados em formulário. Você pode ver exemplos das chamadas corretas em https://dev.megaport.com. Selecione seu idioma preferido no menu suspenso desta página para ver exemplos de como realizar qualquer ação no ambiente da API. |
| Limites da API | Limite geral de taxa Há um limite de 500 requisições em uma janela deslizante de 5 minutos por endereço IP. Atualizações de serviço Você só pode fazer uma atualização de serviço a cada 5 minutos e há um máximo de 100 atualizações por mês por serviço. Nota: Atualmente, esses não são limites rígidos, mas a Megaport monitora e analisa quando os limites são ultrapassados. Se ocorrerem violações de limite, o acesso poderá ser bloqueado. |
Mensagens de erro comuns da API
Erro de login
"message": "Bad session token - try logging in again."
Causas comuns:
- nome de usuário, e-mail ou senha incorretos
- token ausente ou incorreto
Erro de sintaxe
HTTP Status 400 – Bad Request
Esse erro geralmente ocorre quando uma parte obrigatória da sintaxe está ausente ou incorreta.
URL da API incorreta
Um exemplo de erro relacionado à URL incorreta é:
“message”:” Service abcd1234 has wrong product type VXC”
Para este cenário, o cliente usou esta URL:
URL = "https://api-staging.megaport.com/v2/product/megaport/abcd1234-1234-1234-1234-abcdef123456/telemetry?from=1614283800000&to=1614284400000&type=BITS"
mas a URL correta é:
URL = "https://api-staging.megaport.com/v2/product/vxc/abcd1234-1234-1234-1234-abcdef123456/telemetry?type=A_BITS&from=1614283800000&to=1614284400000"
Parâmetros incorretos
Como exemplo, um cliente relatou ausência de saída de dados ao solicitar telemetria do VXC para este intervalo de tempo:
- De: GMT: terça-feira, 3 de agosto de 2021 1:52:23 PM
- Até: GMT: terça-feira, 3 de agosto de 2021, 1:57:23 PM
Sintaxe
https://api-staging.megaport.com/v2/product/vxc/abcd1234-1234-0000000000telemetry?type=A_BITS&from=1627998743&to=1627999043
Saída
{“serviceUid”:”abcd1234-1234-0000000000”,”type”:”A_BITS”,”timeFrame”:{“from”:1627998743,”to:”1627999043},”data”:[ ]}
De acordo com a Get VXC Telemetry docs os parâmetros From e To devem ser definidos em milissegundos para cada valor de epoch (ou seja, cada valor precisava de zeros extras no final):
https://api-staging.megaport.com/v2/product/vxc/abcd1234-1234-0000000000telemetry?type=A_BITS&from=1627998743000&to=1627999043000
Dados exigidos pela Megaport
Se as ações de solução de problemas não resolverem seu problema, entre em contato com o Suporte da Megaport. Com um problema de API, a Megaport investigará e solucionará o problema no back-end.
Para ajudar na investigação, forneça os resultados dos testes que você realizou e quaisquer outras informações relevantes, como:
- E-mail/conta utilizada
- Data, hora e fuso horário da ação e quando o erro ocorreu
- Configuração da API
- URL da API
- Dados do corpo (body)
- Parâmetros do endpoint e sintaxe
- Tipo de erro e uma captura de tela do erro