Solución de problemas de la API de Looker

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

No se puede acceder extremo de API

Si no puedes acceder a un extremo de API, haz lo siguiente:

Verifica tus credenciales de la API

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

  1. En Looker, accede al panel Administrador seleccionando la opción Administrador en el panel de navegación izquierdo.
  2. En el panel izquierdo de la página Administrador, desplázate hacia abajo y haz 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. Podrás ver el ID de cliente y hacer clic en el ícono del ojo para ver el Secreto de cliente de cada clave de API que hayas configurado. Verifica que las credenciales de la API coincidan con las credenciales que utilizas 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 usen 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 de host de la API para el usuario.

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

  1. Para acceder al panel Administrador, selecciona la opción Administrador en el panel de navegación izquierdo.
  2. Haz 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 el siguiente:

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

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

  1. Abre un navegador y, luego, la consola del navegador.

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

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

    Si el campo URL del host de la API está en blanco, usa la URL de la API predeterminada. 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>.cloud.looker.com:443/alive

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

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

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

También puedes verificar si llegaste a la API si observas la respuesta de red en la consola del navegador. La respuesta de la red debe ser 200.

Si estas verificaciones fallan, es posible que estés llamando a la API de forma incorrecta o que tengas otros errores en el código. Verifica tus llamadas a la API y el código de la secuencia de comandos. Si los datos son correctos, consulta la siguiente sección sobre cómo 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 deba abrirse en la infraestructura de red.

El puerto de la API debe reenviar al servidor de Looker. En el caso de las implementaciones de Looker alojadas por el cliente, pídele a tu administrador de red que revise la configuración del puerto de la API. Por lo general, el puerto de la API es 443 o 19999. El puerto de la API debe tener los mismos parámetros de configuración que el puerto de la instancia de Looker (9999 de forma predeterminada). Tu administrador de red debe verificar que la siguiente configuración sea la misma para el puerto de la API y el 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 la URL del extremo de una API es el siguiente:

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

Si usas la URL predeterminada del host de la API, el formato de una URL de extremo de 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 APIs 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 Get All Running Queries:

/api/4.0/running_queries

Por lo tanto, la URL completa del extremo de API para el extremo Get todas las consultas en ejecución en la instancia docsexamples.dev.looker.com de Looker sería la siguiente:

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

El resultado de la API es texto sin sentido

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

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

Las llamadas a la API no responden

Si puedes abrir el Explorador de APIs, pero tus llamadas a la API no responden, verifica que el parámetro de configuración URL del host de la API de tu instancia de Looker esté configurado 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 (se describe en la página de documentación de Configuración del 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 del 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 en application/json.

Ten en cuenta que usar un SDK de Looker se encargará automáticamente de esta inquietud.

Errores de método no encontrado

Si recibes un error de método no encontrado, como method not found: all_looks(), lo primero que debes verificar es la versión de tu 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 con disponibilidad general para ver 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. A menudo, la causa es un JSON dañado o no válido, quizás un error de análisis. En su mayoría, 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 (401) no autorizados

Un error 401 Unauthorized en una llamada a la API significa que la llamada a la API no se autenticó de forma correcta. Para obtener más detalles sobre la solución de problemas, consulta ¿Cómo soluciono los errores 401? Artículo de la Comunidad.

Errores Prohibidos (403)

La API de Looker no devuelve errores 403 cada vez que un usuario intenta acceder a un objeto de LookML o a otro contenido para el que no tenga permiso. Mostrar un error 403 en lugar de 404 podría, en algunos casos, verificar la existencia de un objeto de exploración, panel o LookML en particular cuando el propietario preferiría que se desconozca. Para evitarlo, Looker muestra un error 404 en estos casos y el error adjunto en la IU de Looker dice: “The page you found could not be found. No existe o no tienes permiso para verlo".

Según el entorno en el que se aloje tu instancia de Looker y la configuración de la instancia, el número de puerto y la URL asociada donde se puede acceder a la API pueden ser diferentes. Si 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 de API predeterminado 443, la conexión a https://mycompany.looker.com/api/4.0/login, en lugar de https://mycompany.looker.com:443/api/4.0/login, mostrará un error 403. En el caso de las instancias alojadas por el cliente, puedes leer más 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 suceder cuando no incluyes la porción /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 (404) no encontrado

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

Si los intentos de acceso a la API muestran errores 404, lo más probable es que se deba a que el secreto de cliente o el ID de cliente de la API no son válidos (consulta Verifica tus credenciales de API más arriba en esta página). El extremo de REST de acceso a la API es el siguiente:

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

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

  • Para un cliente de Codegen de Swagger, el base_url debe ser el siguiente:

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

  • Para las implementaciones del SDK de Looker que usan un looker.ini, el valor de api_version debe ser 4.0, 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>. El siguiente es un archivo looker.ini de ejemplo:

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

También puedes recibir un error 404 después de acceder. Si iniciaste sesión y recibes un error 404, eso significa que no tienes permisos para el comando de la API al que acabas de llamar.

Errores (405) de método no permitido

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

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 admite el recurso de destino.

Por ejemplo, una forma en la que podrías encontrar esto en Looker sería si intentaras usar el extremo update_dashboard() para actualizar los metadatos de un panel de LookML. El cambio del parámetro id de un panel de LookML no es compatible con la API de Looker, por lo que se produciría un error 405.

Errores de conflicto (409)

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

Lo más probable es que se produzcan conflictos en respuesta a una solicitud PUT. Un ejemplo común de este error externo a Looker ocurre cuando se sube un archivo anterior al que ya existe en el servidor, lo que provoca un conflicto de control de versión.

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

Errores de validación (422)

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

  • Faltan campos: 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 el valor no tiene el formato correcto. Por ejemplo, si intentas crear una vista y el ID de consulta que proporcionas en la llamada a la API no coincide con una consulta existente, recibirás un error de validación.
  • Ya existe: La llamada a la API intenta crear un objeto con un ID o nombre que ya existe en tu instancia de Looker. Por ejemplo, los nombres de conexión de base de datos deben ser únicos. Si intentas crear una nueva conexión de base de datos que usa el nombre de una conexión existente, recibirás un error de validación con el código already_exists.

Consulta el mensaje de respuesta de error para obtener detalles sobre los campos que pueden faltar o ser obligatorios, o los campos que tienen valores no válidos. El mensaje de respuesta proporcionará todos los errores de validación al mismo tiempo. Por lo tanto, si te faltan campos y también campos incorrectos, la respuesta de error mostrará una lista de 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 obligatorio dialect y también tenía un valor no válido proporcionado 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"). Puedes obtener más información sobre las políticas de límite de frecuencia de Looker en la publicación de Comunidad de Looker. ¿Hay un límite para la cantidad de solicitudes a la API que puedes enviar a la vez?

Errores de error interno del servidor (500)

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

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