Solución de problemas de la API de Looker

En esta página, se muestran los procedimientos para solucionar los siguientes problemas que puedes encontrar en la API de Looker:

No se puede acceder al extremo de la API

Si no puedes acceder a un extremo de API:

Verifica tus credenciales de API

Si no se puede acceder al extremo de la API de Looker, primero verifica que tus credenciales de la API sean correctas. Para ver tus credenciales de API, sigue estos pasos:

  1. En Looker, para acceder al panel Administrador, seleccione la opción Administrador en el panel de navegación izquierdo.
  2. En el panel izquierdo de la página Administrador, desplácese hacia abajo y haga clic en Usuarios.
  3. Busca tu nombre de usuario en la lista de usuarios y haz clic en él para editar tu página de usuario.
  4. Haz clic en Editar claves de API. Puede ver el ID de cliente y hacer clic en el ícono de ojo para ver el secreto del cliente de cada clave de API que configuró. Verifica que tus credenciales de API coincidan con las credenciales que usas en tu secuencia de comandos.

Verifica la URL de la API

Otro problema común para llegar a un extremo de API es una URL de host de API incorrecta. La mayoría de las instancias de Looker usan la URL predeterminada para la API. Sin embargo, es posible que las instalaciones de Looker que usan una ruta de API alternativa o las instalaciones de Looker ubicadas detrás de un balanceador de cargas (por ejemplo, una configuración de clúster) o cualquier otro proxy no usen la URL predeterminada. Si este es el caso, la URL del host de la API debe indicar el puerto y el nombre del host de la API para el usuario.

Los administradores de Looker pueden ver la URL del host de la API en la configuración de administrador de la API (que se describe con más detalle en la página de documentación Configuración del administrador: API). Para ver la URL del host de la API, haz lo siguiente:

  1. Para acceder al panel Administrador, seleccione la opción Administrador en el panel de navegación izquierdo.
  2. Haga clic en API en el panel Administrador.

  3. Consulta la URL del host de la API.

    Si el campo URL del host de la API está en blanco, tu instancia de Looker usa el formato predeterminado, que es:

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

Para probar la URL del host de la API, haz lo siguiente:

  1. Abre un navegador y abre la consola del navegador. (Este artículo de ConcreteCMS.org podría resultarte útil si necesitas saber cómo abrir una consola en tu navegador).

  2. Ingresa la URL del host de la API seguida de /alive. Por ejemplo, si la URL del host de la API es https://company.api.looker.com, ingresa:

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

    Si el campo URL del host de la API está en blanco, utiliza la URL predeterminada de la API. Por ejemplo, para las instancias alojadas en Google Cloud, Microsoft Azure y las instancias alojadas en Amazon Web Services (AWS) que se crearon a partir del 07/07/2020, la ruta predeterminada de la API de Looker usa el puerto 443:

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

    Para las instancias alojadas en AWS que se crearon antes del 07/07/2020, la ruta predeterminada de la API de Looker usa el puerto 19999:

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

Si la URL del host de la API es correcta, esta URL generará una página web en blanco, no una página de error:

También puedes verificar que hayas llegado a la API observando la respuesta de red en la consola del navegador. La respuesta de la red debe ser 200:

Si fallan estas verificaciones, es posible que el problema sea que llama a la API de forma incorrecta o que tenga otros errores en su código. Verifica las llamadas a la API y el código en la secuencia de comandos. Si eso es correcto, consulta la siguiente sección para verificar tu puerto.

Verifica el puerto de la API

Si las verificaciones anteriores fallan y tienes una implementación de Looker alojada por el cliente, es posible que el puerto de la API esté abierto en la infraestructura de red.

El puerto de la API debe reenviar al servidor de Looker. Para las implementaciones de Looker alojadas por el cliente, pídele a tu administrador de red que verifique la configuración del puerto de API. El puerto de API suele ser 443 o 19999. El puerto de la API debe tener los mismos ajustes que el puerto de la instancia de Looker (de forma predeterminada, 9999). El administrador de red debe verificar que la configuración del puerto de la API sea la misma que la del puerto de la instancia de Looker:

  • Proxies
  • Balanceadores de cargas
  • Firewalls

Verifica la URL de llamada a la API

Verifica que estés usando la URL correcta para tu llamada a la API. El formato de una URL de extremo de API es el siguiente:

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

Si usas la URL del host de la API predeterminada, el formato de una URL de extremo de la API es el siguiente:

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

Puedes obtener el formato de URL para los extremos de la API en el Explorador de API, en el Portal para desarrolladores de Looker o en la documentación de Referencia de la API.

Por ejemplo, la referencia de la API 4.0 proporciona la siguiente ruta de acceso relativa para el extremo Obtener todas las consultas:

Por lo tanto, la URL completa del extremo de la API para la instancia de Looker docsexamples.dev.looker.com es la siguiente:

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

El resultado de la API es un texto sin sentido

Si la API muestra una respuesta de texto ilegible, es probable que estés viendo el contenido binario de un archivo PDF, PNG o JPG. Algunas bibliotecas REST de HTTP suponen que las respuestas de la API serán archivos de texto, por lo que otros tipos de archivos se mostrarán como texto binario.

En este caso, debes asegurarte de que tu biblioteca HTTP REST maneje la respuesta de la API como datos binarios, no como texto. En algunos casos, esto puede significar configurar una marca en la llamada a la API para indicarle a la biblioteca REST de HTTP que es un resultado binario, o podría tratarse el resultado de manera especial, por ejemplo, como un flujo de bytes o como un arreglo de bytes, en lugar de asignar el resultado a una variable de string.

Las llamadas a la API no responden

Si puedes abrir el Explorador de API, pero las llamadas a la API no responden, verifica que la opción URL del host de la API de la instancia de Looker esté configurada correctamente. Los administradores de Looker pueden ver la URL del host de la API en la configuración de administrador de la API de Looker (que se describe en la página de documentación Configuración de administrador: API).

Errores de codificación no válidos

Si recibes un error de codificación cuando intentas realizar una llamada a la API, es posible que debas configurar el Content-Type adecuado en el encabezado durante la solicitud. Los estándares de protocolo HTTP requieren que cualquier solicitud POST, PUT o PATCH contenga un encabezado Content-Type. Dado que la API de Looker usa JSON en todo momento, el encabezado Content-Type debe establecerse como application/json.

Ten en cuenta que, si usas un SDK de Looker, se ocupará de este problema automáticamente.

Errores de método no encontrado

Si recibes un error Método no encontrado, como method not found: all_looks(), lo primero que debes verificar es la versión de la API. Hay varias llamadas a la API que son nuevas en la API 4.0 o que se quitaron en la API 4.0. Consulta el anuncio de la API de Looker 4.0 disponible para el público general a fin de obtener la lista de actualizaciones.

Errores de solicitud incorrecta (400)

Un error 400 Bad Request indica que los datos proporcionados en una llamada a la API son irreconocibles. La causa suele ser un archivo JSON no válido o no válido, quizás un error de análisis. En su mayor parte, los errores 400 ya pasaron la autenticación, por lo que el mensaje de respuesta de error proporcionará información más específica sobre el error.

Errores prohibidos (403)

La API de Looker no muestra errores 403 cada vez que un usuario intenta acceder a un objeto LookML o a otro contenido para el que no tiene permiso. Mostrar un error 403 en lugar de un error 404 podría, en algunos casos, verificar la existencia de un objeto Explorar, un panel o un LookML en particular cuando el propietario puede preferir que esto no se conozca. Para evitar esto, Looker muestra un error 404 en estos casos y el error que lo acompaña en la IU de Looker dice: “No se pudo encontrar la página solicitada. No existe o no tienes permiso para verla.

Según el entorno en el que se aloje tu instancia de Looker y la configuración de tu instancia de Looker, el número de puerto y la URL asociada donde se puede acceder a la API pueden ser diferentes. Cuando usas un número de puerto incorrecto, es posible que veas un error 403. Por ejemplo, si tu instancia de Looker está configurada con el puerto 443 predeterminado de la API, la conexión a https://mycompany.looker.com/api/4.0/login, en lugar de a https://mycompany.looker.com:443/api/4.0/login, mostrará un error 403. Para las instancias alojadas por el cliente, puedes obtener más información sobre las opciones de inicio de Looker en las que puedes definir el puerto de la API.

Esto también puede ocurrir cuando usas una versión desactualizada de la gema del SDK de Ruby. Asegúrate de mantener esas gemas actualizadas. Puedes comprobarlo en https://rubygems.org/gems/looker-sdk.

Esto también puede ocurrir cuando no incluyes la parte /api/<version number>/ de la URL. En este caso, si un usuario intenta conectarse a https://mycompany.looker.com:443/login, verá una respuesta 403.

Errores no encontrados (404)

Un error 404 Not Found es el error predeterminado si algo sale mal, por lo general, con aspectos como los permisos. El mensaje de respuesta para un error 404 proporciona información mínima, si la hubiera. Esto es intencional, ya que se muestran errores 404 a personas con credenciales de acceso incorrectas o permisos insuficientes. Looker no desea proporcionar información específica en los mensajes de respuesta 404, ya que esta información podría usarse para mapear la “superficie de ataque” de la API de Looker.

Si los intentos de acceso de la API muestran errores 404, es probable que se deba a que tu ID de cliente API3 o tu secreto del cliente no son válidos (consulta Verifica tus credenciales de la API anteriormente en esta página). El extremo de acceso de API de REST es uno de los siguientes, según la versión de API en uso:

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

Si usas una API de Codegen Swagger o un SDK de Looker, asegúrate de que tu valor base_url sea correcto:

  • Para un cliente de Codegen Swagger, el base_url debe ser uno de los siguientes, según la versión de la API en uso:
    • https://<your-looker-hostname>:<port>/api/4.0/
    • https://<your-looker-hostname>:<port>/api/3.1/

  • Para las implementaciones del SDK de Looker que usan un looker.ini, el valor de api_version debe ser 4.0 o 3.1, y el valor de base_url debe ser el mismo que la URL de la API de tu instancia de Looker con el formato https://<your-looker-hostname>:<port>. A continuación, se muestra un ejemplo de un archivo looker.ini:

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

También puedes obtener un error 404 después de acceder. Si accediste a tu cuenta y recibes un error 404, significa que no tienes permisos para el comando de la API que acabas de llamar.

Errores del método no permitido (405)

Un error 405 Method Not Allowed indica que el servidor conoce el método de solicitud, pero el recurso de destino no admite este método.

El servidor debe generar un campo de encabezado Allow en una respuesta de código de estado 405. El campo debe contener una lista de métodos que el recurso de destino admite actualmente.

Por ejemplo, una forma de encontrar esto en Looker sería si intentara usar el extremo update_dashboard() para actualizar los metadatos de un panel de LookML. No se admite cambiar el parámetro id de un panel de LookML a través de la API de Looker, por lo que se produciría un error 405.

Errores (409) en conflicto

El código de estado de respuesta 409 Conflict indica un conflicto de solicitud con el estado actual del recurso de destino.

Es más probable que haya conflictos en respuesta a una solicitud PUT. Un ejemplo común de este error que no es de Looker se produce cuando se sube un archivo más antiguo que el existente en el servidor, lo que genera un conflicto de control de versión.

Es posible que encuentres este error en Looker cuando intentes verificar una nueva rama de Git mediante la API o cuando uses extremos como create_group() o create_dashboard(). En estos casos, verifica si el objeto que intentas crear ya existe.

Errores de validación (422)

Los errores de validación ocurren cuando algo en la solicitud falla en las verificaciones de datos realizadas. La solicitud tiene uno o más de los siguientes tipos de errores (la respuesta de error especificará los errores exactos):

  • Campos faltantes: Hay un parámetro obligatorio que no se proporcionó (la respuesta de error indicará qué campo falta).
  • No válido: El valor proporcionado no coincide con un valor existente o no tiene el formato correcto. Por ejemplo, si intentas crear un estilo y el ID de consulta que proporcionas en la llamada a la API no coincide con una existente, se mostrará un error de validación.
  • Ya existe: La llamada a la API intenta crear un objeto con un ID o nombre que ya está presente en su instancia de Looker. Por ejemplo, los nombres de conexión a la base de datos deben ser únicos. Si intentas crear una conexión de base de datos nueva que use el nombre de una conexión existente, recibirás un error de validación con el código already_exists.

Consulte el mensaje de respuesta de error para obtener detalles sobre los campos que faltan o son obligatorios, o sobre los que pueden tener valores no válidos. El mensaje de respuesta proporcionará todos los errores de validación al mismo tiempo. Por lo tanto, si faltan campos y también hay campos incorrectos, la respuesta de error mostrará todos los problemas con tu llamada a la API.

A continuación, se muestra un ejemplo de respuesta:

{
  "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/"
    }
  ],
    ...

En este caso, a la llamada a la API le faltaba el campo dialect obligatorio y también tenía un valor no válido en db_timezone.

Demasiadas solicitudes (429) Errores

El código de estado de respuesta 429 Too Many Requests indica que el usuario envió demasiadas solicitudes en un período determinado (límite de frecuencia). Para obtener más información sobre las políticas de límite de frecuencia de Looker, consulta el artículo de la comunidad de Looker ¿Hay un límite para la cantidad de solicitudes a la API que se pueden enviar al mismo tiempo?

Errores internos del servidor (500)

El código de respuesta 500 Internal Server Error indica que el servidor encontró una condición inesperada que impidió que se cumpliera la solicitud.

Esta respuesta de error es una respuesta genérica. Por lo general, esto indica que el servidor no puede encontrar un código de error 5xx más específico para mostrar en respuesta. Cualquier respuesta 500 de Looker es inesperada, por lo que, si ves este error de forma constante mientras intentas interactuar con Looker, te recomendamos que te comuniques con el equipo de asistencia de Looker.