Saiba como depurar operações de API da Alibaba Cloud online no OpenAPI Explorer.
Crie uma conta Alibaba Cloud
Chamadas de API exigem uma conta Alibaba Cloud. Caso ainda não possua uma, registre-se no site oficial da Alibaba Cloud.
Ativar services da Alibaba Cloud
Ative os services da Alibaba Cloud que deseja utilizar. O exemplo a seguir usa o SMS:
Acesse o User Center, pesquise por Short Message Service e clique em Activate.
Acesse o console do service, como o console de SMS, e clique em Activate.
É obrigatório ativar um service da Alibaba Cloud antes de invocar suas operações de API.
Depurar uma operação de API online
Faça login no OpenAPI Explorer, selecione um service ativado da Alibaba Cloud, como o ECS, e clique em Debug.
Selecione a operação de API para depuração, como DescribeInstanceTypeFamilies para ECS. Na seção Parameters, insira os valores conforme descrito na aba Document e clique em Initiate Call. OpenAPI online debugging.
Resposta
A aba Response exibe o HTTP status code e os dados retornados pela chamada.
Esta aba também apresenta informações de Request Header e Response Header.
Chamada bem-sucedida
Uma chamada bem-sucedida retorna o código de status HTTP 200 com uma resposta JSON. A documentação da API detalha cada parâmetro, como na referência de DescribeInstanceTypeFamilies.
Chamada com falha
Uma chamada com falha retorna um código de status HTTP na faixa 4xx. As APIs da Alibaba Cloud usam uma estrutura unificada de resposta de erro, exceto alguns services que não utilizam o gateway padrão. O exemplo abaixo ilustra o formato de erro da operação RunInstances do ECS:
{
"RequestId": "7DC0013A-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"Message": "The specified endpoint cant operate this region. Please use API DescribeRegions to get the appropriate endpoint, or upgrade your SDK to latest version.(from POP)",
"Recommend": "https://api.alibabacloud.com/troubleshoot?q=InvalidOperation.NotSupportedEndpoint&product=Ecs&requestId=7DC0013A-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"HostId": "ecs-cn-hangzhou.aliyuncs.com",
"Code": "InvalidOperation.NotSupportedEndpoint"
}|
Parâmetro |
Descrição |
|
RequestId |
ID de solicitação globalmente único. Forneça este |
|
HostId |
Endpoint do service onde ocorreu o erro. Neste exemplo, refere-se ao endpoint do ECS na região China (Hangzhou). |
|
Code |
Identificador curto do tipo de erro. Consulte este código na documentação da Alibaba Cloud para encontrar soluções. No exemplo, o endpoint não oferece suporte à região de destino. |
|
Message |
Mensagem de erro detalhada. Neste caso, o endpoint não suporta a região selecionada. Use a API |
|
Recommend |
URL de diagnóstico. Abra este link para acessar o OpenAPI Troubleshoot e obter soluções. |
Para solucionar erros, use o OpenAPI Troubleshoot.
Código de exemplo do SDK
Na aba SDK sample code, selecione uma SDK version e linguagem, depois clique em Run Example.
Você também pode clicar em View Version Differences para comparar versões do SDK, em Download Full Project para baixe o código ou alternar Generate Example in Common Mode para mudar o modo de geração.
Exemplo de CLI
Na aba CLI example, clique no botão de execução para depurar o comando online.
Histórico de chamadas
A aba Call History lista suas chamadas de API anteriores. Revise os parâmetros e clique em Redebug para execute novamente uma chamada. Se o status de uma chamada indicar falha, use Diagnose para identificar a causa.
Códigos de erro
A aba Error Codes lista possíveis erros e suas descrições. Clique em Diagnose para abrir a página de diagnóstico, que fornece documentos relevantes, discussões em fóruns e opções de suporte.
Por exemplo, insira um RegionId inválido retorna o código de status HTTP 404, o código de erro InvalidRegionId.NotFound e a mensagem The RegionId provided does not exist in our records..