Solução de problemas da API Looker

Esta página tem procedimentos de solução para os seguintes problemas que você pode encontrar com a API Looker:

Endpoint de API não está acessível

Se não for possível acessar um endpoint de API:

Verificar suas credenciais da API

Se o endpoint de API Looker não estiver acessível, primeiro verifique se as credenciais da API estão corretas. Para ver suas credenciais da API:

  1. No Looker, acesse o painel Administrador selecionando a opção Administrador no painel de navegação à esquerda.
  2. No painel esquerdo da página Administrador, role para baixo e clique em Usuários.
  3. Pesquise seu nome de usuário na lista de usuários e clique nele para editar a página de usuário.
  4. Clique em Editar chaves de API. Você pode consultar o ID do cliente e clicar no ícone de olho para conferir a chave secreta do cliente de cada chave de API configurada. Verifique se as credenciais da API correspondem às que você está usando no script.

Verifique o URL da API

Outro problema comum em alcançar um endpoint de API é um URL de host de API incorreto. A maioria das instâncias do Looker usa o URL padrão para a API. No entanto, as instalações do Looker que usam um caminho alternativo de API ou instalações do Looker localizadas atrás de um balanceador de carga (por exemplo, uma configuração de cluster) ou qualquer outro proxy podem não usar o URL padrão. Se esse for o caso, o URL do host da API precisará indicar o nome do host e a porta da API voltados para o usuário.

Os administradores do Looker podem consultar o URL do host da API nas configurações de administrador da API (descritos em mais detalhes na página de documentação Configurações de administrador – API). Para ver o URL do host da API:

  1. Para acessar o painel Administrador, selecione a opção Administrador no painel de navegação à esquerda.
  2. Clique em API no painel Administrador.

  3. Veja o URL do host da API.

    Se o campo URL do host da API estiver em branco, a instância do Looker vai usar o formato padrão, que é:

    https://<instance_name>.cloud.looker.com:<port>

Para testar o URL do host da API:

  1. Abra um navegador e o console do navegador.

  2. Digite o URL do host da API seguido de /alive. Por exemplo, se o URL do host da API for https://company.cloud.looker.com, insira:

    https://company.cloud.looker.com/alive

    Se o campo URL do host da API estiver em branco, use o URL da API padrão. Por exemplo, para instâncias hospedadas no Google Cloud, Microsoft Azure e instâncias hospedadas na Amazon Web Services (AWS) que foram criadas a partir de 07/07/2020, o caminho padrão da API Looker usa a porta 443:

    https://<instance_name>.cloud.looker.com:443/alive

    Para instâncias hospedadas na AWS que foram criadas antes de 07/07/2020, o caminho padrão da API Looker usa a porta 19999:

    https://<instance_name>.cloud.looker.com:19999/alive

Se o URL do host da API estiver correto, esse URL resultará em uma página da Web em branco, não em uma página de erro.

Você também pode verificar se acessou a API observando a resposta da rede no console do navegador. A resposta da rede precisa ser 200.

Se essas verificações falharem, o problema pode ser que você esteja chamando a API incorretamente ou tenha outros erros no código. Verifique suas chamadas de API e o código no script. Se elas estiverem corretas, consulte a próxima seção sobre como verificar a porta.

Verificar a porta da API

Se as verificações anteriores falharem e você tiver uma implantação do Looker hospedada pelo cliente, talvez a porta da API precise ser aberta na infraestrutura da rede.

A porta da API precisa encaminhar para o servidor do Looker. Para implantações do Looker hospedadas pelo cliente, peça ao administrador da rede para verificar as configurações da porta da API. A porta de API costuma ser 443 ou 19999. A porta da API precisa ter as mesmas configurações da porta da instância do Looker (9999 por padrão). O administrador da rede precisa verificar se as configurações a seguir são as mesmas para a porta de API e a porta da instância do Looker:

  • Proxies
  • Balanceadores de carga
  • Firewalls

Verificar o URL da chamada de API

Verifique se você está usando o URL correto para sua chamada de API. O formato de um URL de endpoint de API é:

<API Host URL>/api/<API version>/<API call>

Se você estiver usando o URL de host da API padrão, o formato de um URL endpoint de API será:

https://<instance_name>:<port>/api/<API version>/<API call>

Você pode conferir o formato do URL dos endpoints da API no APIs Explorer ou na documentação da Referência da API.

Por exemplo, a Referência da API 4.0 fornece o seguinte caminho relativo para o endpoint "Receber todas as consultas em execução":

/api/4.0/running_queries

Portanto, o URL completo do endpoint de API para o endpoint "Acessar todas as consultas em execução" na instância docsexamples.dev.looker.com do Looker seria o seguinte:

https://docsexamples.dev.looker.com:443/api/4.0/running_queries

O resultado da API é um texto sem sentido

Se a API retornar uma resposta de texto truncado, é provável que você esteja vendo o conteúdo binário de um arquivo PDF, PNG ou JPG. Algumas bibliotecas HTTP REST presumem que as respostas da API serão arquivos de texto. Assim, outros tipos de arquivos são exibidos como texto binário.

Nesse caso, você precisa ter certeza de que sua biblioteca HTTP REST processa a resposta da API como dados binários, não como texto. Em alguns casos, isso pode significar definir uma flag na chamada de API para informar à biblioteca HTTP REST que é um resultado binário ou pode significar lidar com o resultado de maneira especial, como um fluxo de bytes ou como uma matriz de bytes, em vez de atribuir o resultado a uma variável de string.

As chamadas de API não respondem

Se você conseguir abrir o APIs Explorer, mas as chamadas de API não responderem, verifique se a configuração URL do host da API da instância do Looker está definida corretamente. Os administradores do Looker podem consultar o URL do host da API nas configurações de administrador da API Looker, descritas na página de documentação Configurações de administrador – API.

Erros de codificação inválidos

Se você receber um erro de codificação ao tentar fazer uma chamada de API, talvez seja necessário definir o Content-Type adequado no cabeçalho durante a solicitação. Os padrões do protocolo HTTP exigem que qualquer solicitação POST, PUT ou PATCH contenha um cabeçalho Content-Type. Como a API Looker usa JSON sempre, o cabeçalho Content-Type precisa ser definido como application/json.

Se você usar um SDK do Looker, esse problema vai ser resolvido automaticamente.

Erros "Método não encontrado"

Se você receber um erro "Método não encontrado", como method not found: all_looks(), a primeira coisa a verificar é a versão da API. Há várias chamadas de API que são novas na API 4.0 ou que foram removidas na API 4.0. Consulte o anúncio da API Looker 4.0 em disponibilidade geral para conferir a lista de atualizações.

Erros de Solicitação inválida (400)

Um erro 400 Bad Request indica que os dados fornecidos em uma chamada de API não foram reconhecidos. O culpado costuma ser um JSON corrompido ou inválido, talvez um erro de análise. Como a maioria dos erros 400 já passou na autenticação, a mensagem de resposta de erro fornecerá informações mais específicas sobre o erro.

Erros não autorizados (401)

Um erro 401 Unauthorized em uma chamada de API significa que a chamada não está devidamente autenticada. Para mais detalhes sobre solução de problemas, consulte Como solucionar erros 401? Artigo da comunidade.

Erros proibidos (403)

A API Looker não retorna erros 403 sempre que um usuário tenta acessar um objeto do LookML ou outro conteúdo sem permissão para isso. Retornar um erro 403 em vez de um erro 404 pode, em alguns casos, verificar a existência de um determinado objeto Explore, dashboard ou LookML, caso o proprietário prefira que isso não seja conhecido. Para evitar isso, o Looker retorna um erro 404 nesses casos, e o erro de acompanhamento na interface do Looker diz: "Não foi possível encontrar a página solicitada. Ele não existe ou você não tem permissão para visualizá-lo."

Dependendo do ambiente em que a instância do Looker está hospedada e da configuração dela, o número da porta e o URL associado em que a API pode ser acessada podem ser diferentes. Ao usar um número de porta incorreto, você pode receber um erro 403. Por exemplo, se a instância do Looker estiver configurada com a porta de API padrão 443, a conexão com https://mycompany.looker.com/api/4.0/login em vez de https://mycompany.looker.com:443/api/4.0/login vai retornar um erro 403. No caso de instâncias hospedadas pelo cliente, leia mais sobre as opções de inicialização do Looker, em que é possível definir a porta da API.

Isso também pode acontecer quando você usa uma versão desatualizada da gem do SDK do Ruby. Mantenha essas pedras preciosas atualizadas. Você pode verificar isso em https://rubygems.org/gems/looker-sdk.

Isso também pode acontecer quando você não inclui a parte /api/<version number>/ do URL. Nesse caso, se um usuário tentar se conectar ao https://mycompany.looker.com:443/login, ele vai receber uma resposta 403.

Erros "Não encontrado" (404)

O 404 Not Found será o erro padrão se algo der errado, geralmente relacionado a permissões. A mensagem de resposta para um erro 404 fornece poucas informações, se houver alguma. Isso é intencional, já que erros 404 são mostrados para pessoas com credenciais de login incorretas ou permissões insuficientes. O Looker não quer fornecer informações específicas em mensagens de resposta 404, já que elas podem ser usadas para mapear a "superfície de ataque" da API Looker.

Se as tentativas de login da API retornarem erros 404, é provável que o ID ou a chave secreta do cliente da API não sejam válidos. Consulte Verificar suas credenciais da API anteriormente nesta página. O endpoint REST de login da API é o seguinte:

  • https://<your-looker-hostname>:<port>/api/4.0/login

Se você estiver usando uma API codegen do Swagger ou um SDK do Looker, verifique se o valor base_url está correto:

  • Para um cliente codegen Swagger, o base_url precisa ser o seguinte:

    • https://<your-looker-hostname>:<port>/api/4.0/

  • Para implementações do SDK do Looker que usam um looker.ini, o valor de api_version precisa ser 4.0, e o de base_url precisa ser igual ao URL da API da instância do Looker no formato https://<your-looker-hostname>:<port>. Segue um exemplo de arquivo looker.ini:

    # api_version should be 4.0
api_version=4.0
base_url=https://<your-looker-hostname>:<port>

Você também pode receber um erro 404 após fazer login. Se você fez login e receber um erro 404, isso significa que você não tem permissões para o comando da API que acabou de chamar.

Erros de método não permitido (405)

Um erro 405 Method Not Allowed indica que o servidor conhece o método da solicitação, mas o recurso de destino não oferece suporte a esse método.

O servidor precisa gerar um campo de cabeçalho Allow em uma resposta do código de status 405. O campo precisa conter uma lista de métodos compatíveis com o recurso de destino.

Por exemplo, uma maneira de encontrar isso no Looker seria usar o endpoint update_dashboard() para atualizar os metadados de um dashboard do LookML. A API Looker não oferece suporte à alteração do parâmetro id de um dashboard do LookML. Portanto, o erro 405 ocorreria.

Erros de conflito (409)

O código de status da resposta 409 Conflict indica um conflito de solicitação com o estado atual do recurso de destino.

É mais provável que ocorram conflitos em resposta a uma solicitação PUT. Um exemplo comum desse erro não relacionado ao Looker ocorre ao fazer upload de um arquivo mais antigo que o atual no servidor, o que resulta em um conflito de controle de versões.

Você pode encontrar esse erro no Looker ao tentar verificar uma nova ramificação do git usando a API ou ao usar endpoints como create_group() ou create_dashboard(). Nesses casos, verifique se o objeto que você está tentando criar já existe.

Erros de validação (422)

Os erros de validação ocorrem quando algo na solicitação falhou nas verificações de dados realizadas. A solicitação tem um ou mais dos seguintes tipos de erros (a resposta de erro especificará os erros exatos):

  • Campos ausentes: há um parâmetro obrigatório que não foi fornecido (a resposta de erro dirá qual campo está ausente).
  • Inválido: o valor fornecido não corresponde a um valor existente ou não está no formato correto. Por exemplo, se você tentar criar um Look e o ID da consulta fornecido na chamada de API não corresponder a uma consulta existente, você receberá um erro de validação.
  • Já existe: a chamada de API está tentando criar um objeto com um ID ou nome que já está na sua instância do Looker. Por exemplo, os nomes de conexão de banco de dados precisam ser exclusivos. Se você tentar criar uma nova conexão de banco de dados que use o nome de uma conexão existente, um erro de validação será exibido com o código already_exists.

Veja a mensagem de resposta de erro para detalhes sobre quais campos podem estar ausentes ou ser obrigatórios, ou quais podem ter valores inválidos. A mensagem de resposta vai mostrar todos os erros de validação ao mesmo tempo. Portanto, se houver campos ausentes e incorretos, a resposta de erro listará todos os problemas com sua chamada de API.

Aqui está um exemplo de resposta:

{
  "message": "Validation Failed",
  "errors": [
    {
    "field": "dialect",
    "code": "missing_field",
    "message": "This field is required.",
    "documentation_url": "http://docs.looker.com/"
    },
    {
    "field": "db_timezone",
    "code": "invalid",
    "message": "Must specify a database timezone when user timezones are activated.",
    "documentation_url": "http://docs.looker.com/"
    }
  ],
    ...

Nesse caso, a chamada de API não tinha o campo obrigatório dialect e também tinha um valor inválido em db_timezone.

Erros de muitas solicitações (429)

O código de status da resposta 429 Too Many Requests indica que o usuário enviou solicitações em excesso em um determinado período ("limitação de taxa"). Leia mais sobre as políticas de limitação de taxa na postagem da Comunidade do Looker Há um limite para o número de solicitações de API que podem ser enviadas de uma só vez?

Erros de erro interno do servidor (500)

O código de resposta 500 Internal Server Error indica que o servidor encontrou uma condição inesperada que o impediu de atender à solicitação.

Essa resposta de erro é genérica. Geralmente, isso indica que o servidor não conseguiu encontrar um código de erro 5xx mais específico para retornar em resposta. Toda resposta 500 do Looker é inesperada. Portanto, se você receber esse erro de forma consistente ao tentar interagir com o Looker, recomendamos abrir uma solicitação de suporte.