Solução de Problemas da API
Se você encontrar problemas com a API ou com a Megaport Terraform solution, siga estas ações de solução de problemas.
Para tutoriais da API e um guia passo a passo, veja Visão Geral da API. Para uma referência completa, incluindo exemplos funcionais, veja https://dev.megaport.com/.
Para testar a API, recomendamos o cliente Postman com a Megaport Collection importada; informações sobre como baixar e usar o Postman estão na documentação.
Ações de Solução de Problemas
Ação | Passos |
---|---|
Certifique-se de que o token de acesso da API é válido | Megaport As chamadas da API 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 um máximo de 24 horas, após o qual você precisará gerar um novo token de acesso. Para mais informações, veja Criando uma Chave de API. |
Certifique-se de que o ambiente da API (URL) está correto | Certifique-se de que as URLs que você está usando são para o ambiente desejado.
|
Certifique-se de que os parâmetros da API estão corretos | A Megaport usa códigos de resposta HTTP padrão. De modo geral, um erro 400 - Bad Request é normalmente causado por parâmetros faltando ou incorretos. Se você estiver recebendo esse erro, verifique novamente seus parâmetros. |
Certifique-se de que a sintaxe da 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 por formulário. Você pode ver exemplos de chamadas corretas em https://dev.megaport.com. Selecione seu idioma preferido no menu suspenso desta página, e você pode ver exemplos de como fazer qualquer coisa dentro do ambiente da API. |
Limites da API | Limite Geral de Taxa Há um limite de taxa de 500 solicitações em um período contínuo de 5 minutos por endereço IP. Atualizações de Serviço Você pode fazer apenas 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. Note: Atualmente, estes não são limites rígidos, mas a Megaport monitora e revisa quando os limites são excedidos. Se houver ocorrências de excedência de limite, o acesso pode ser bloqueado. |
Mensagens Comuns de Erro da API
Erro de Login
"message": "Bad session token - try logging in again."
Causas comuns:
- nome de usuário, email ou senha incorretos
- token faltando ou incorreto
Erro de Sintaxe
HTTP Status 400 – Bad Request
O erro ocorre comumente quando uma sintaxe necessária está faltando ou incorreta.
URL da API Incorreta
Um exemplo do erro relacionado a 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 que não houve saída de dados ao solicitar telemetria do VXC para este intervalo de tempo:
- From: GMT: terça-feira, 3 de agosto de 2021, 13:52:23
- To: GMT: terça-feira, 3 de agosto de 2021, 13:57:23
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”:[ ]}
A partir de documentos Obter VXCTelemetria os parâmetros From e To devem ser configurados em milissegundos para cada valor de época (então 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
Megaport Dados Necessários
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 auxiliar na investigação, forneça os resultados dos testes realizados e qualquer outra informação relevante, como:
- Email/conta utilizada
- Data, hora e fuso horário da ação e quando ocorreu o erro
- Configuração da API
- URL da API
- Dados do corpo da requisição
- Dados do corpo da requisição
- Tipo de erro e uma captura de tela do erro