En esta página, se incluyen procedimientos para solucionar los siguientes problemas que puedes encontrar con la API de Looker:
- No se puede acceder al extremo de la API
- El resultado de la API es texto sin sentido
- Las llamadas a la API no responden
- Errores de codificación no válido
- Errores de método no encontrado
- Errores de solicitud incorrecta (400)
- Errores prohibidos (403)
- Errores (404) No encontrados
- Errores (405) de método no permitido
- Errores de conflicto (409)
- Errores de validación (422)
- Demasiadas solicitudes (429)
- Errores de error interno del servidor (500)
No se puede acceder extremo de API
Si no puedes acceder a un extremo de API, haz lo siguiente:
- Verifica las credenciales de la API
- Verifica la URL del host de la API
- Verifica el puerto de la API
- Verifica la URL de la llamada a la API
Verifica tus credenciales de API
Si no se puede acceder extremo de API de Looker, primero verifica que las credenciales de la API sean correctas. Para ver tus credenciales de API, sigue estos pasos:
- En Looker, selecciona la opción Administrador en el panel de navegación izquierdo para acceder al panel Administrador.
- En el panel izquierdo de la página Administrador, desplázate hacia abajo y haz clic en Usuarios.
- Busca tu nombre de usuario en la lista de usuarios y haz clic en él para editar tu página de usuario.
- Haz clic en Editar claves de API. Puedes 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 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 cuando se intenta acceder a un extremo de API es que la URL del host de la API sea 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 nombre y el puerto del host de la API para el usuario.
Los administradores de Looker pueden ver la URL del host de la API en su configuración (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:
- Accede al panel Administrador seleccionando la opción Administrador en el panel de navegación izquierdo.
- En el panel Administrador, haz clic en API.
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 API, haz lo siguiente:
- Abre un navegador y, luego, abre la consola del navegador.
Ingresa la URL del host de la API y, luego,
/alive
. Por ejemplo, si tu URL del host de API eshttps://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 de 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, se mostrará una página web en blanco, no una página de error.
También puedes verificar si llegaste a la API observando la respuesta de la red en la consola del navegador. La respuesta de la red debe ser 200
.
Si estas verificaciones fallan, el problema puede ser que estás llamando a la API de forma incorrecta o que tienes otros errores en tu código. Verifica tus llamadas a la API y el código de tu secuencia de comandos. Si son correctas, 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 deba estar abierto 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 verifique 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). El administrador de red debe verificar que la siguiente configuración para el 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 la 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 la 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 API 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 de extremo de API correspondiente al extremo Get All Running Queries 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 no tiene 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 y, por lo tanto, otros tipos de archivos se muestran 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 podría significar configurar una marca en la llamada a la API para indicarle a la biblioteca HTTP REST que es un resultado binario, o bien podría significar manejar el resultado de una manera especial, como un flujo de bytes o 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 API, pero las llamadas a la API no responden, verifica que la URL del host de la API de tu 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 (se describe en la página de documentación Configuración del administrador: API).
Errores de codificación no válido
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 tu 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 como application/json
.
Ten en cuenta que, si usas un SDK de Looker, esta inquietud se resolverá automáticamente.
Errores de método no encontrado
Si recibes un error "Method Not Found", 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 disponibilidad general 4.0 de la API de Looker 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 del error proporcionará información más específica sobre el error.
Errores (403) prohibidos
La API de Looker no muestra errores 403 cada vez que un usuario intenta acceder a un objeto de 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 Explore, un panel o un objeto de LookML en particular cuando el propietario podría preferir que esto se desconozca. Para evitarlo, Looker muestra un 404 en estos casos, y el error que lo acompaña en la IU de Looker dice lo siguiente: “No se pudo encontrar la página que solicitaste. 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 esta, el número de puerto y la URL asociada a la que 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
, conectarte 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. Para 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 suceder cuando usas una versión desactualizada de la gema del SDK de Ruby. Asegúrate de mantener esas gemas actualizadas. Puedes consultarlo en https://rubygems.org/gems/looker-sdk
.
Esto también puede ocurrir si no incluyes la parte /api/<version number>/
de la URL. En ese caso, si un usuario intenta conectarse a https://mycompany.looker.com:443/login
, verá una respuesta 403.
Errores No encontrado (404)
El error 404 Not Found
es el error predeterminado si hay algún problema, por lo general, relacionado con los permisos. El mensaje de respuesta para un error 404 proporciona información mínima, si la hay. Esto es intencional, ya que se muestran errores 404 a 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 trazar 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 el secreto de cliente o el ID de cliente de tu API no sean válidos (consulta Verifica las credenciales de la API que se encuentra 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 el 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 deapi_version
debe ser4.0
, y el debase_url
debe ser el mismo que la URL de la API de tu instancia de Looker en el formatohttps://<your-looker-hostname>:<port>
. A continuación, se muestra un archivolooker.ini
de ejemplo:# api_version should be 4.0 api_version=4.0 base_url=https://<your-looker-hostname>:<port>
También puede recibir un error 404 después de iniciar sesión. Si accediste y recibes un error 404, significa que no tienes permisos para el comando de la API al que acabas de llamar.
Errores de 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 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 el recurso de destino admite actualmente.
Por ejemplo, una forma de encontrar esto en Looker sería si intentaras usar el extremo update_dashboard()
para actualizar los metadatos de un panel de LookML. No se admite el cambio del parámetro id
de un panel de LookML mediante 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 que una solicitud entra en conflicto con el estado actual del recurso de destino.
Lo más probable es que los conflictos ocurran 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 anterior al existente en el servidor, lo que genera un conflicto de control de versión.
Es posible que encuentres este error en Looker cuando intentes comprobar una nueva rama de Git con 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 de la solicitud no pasa 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):
- 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 proporcionaste 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 está presente en tu instancia de Looker. Por ejemplo, los nombres de las conexiones de bases de datos deben ser únicos. Si intentas crear una nueva conexión de base de datos que utiliza 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 bien 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 le faltan campos y también campos incorrectos, la respuesta de error mostrará todos los problemas de su 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, además, se había proporcionado 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”). 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 ¿Existe 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. Por lo general, esto indica que el servidor no puede encontrar un código de error 5xx más específico para mostrar como respuesta. Cualquier respuesta 500 de Looker es inesperada, por lo que, si ves este error de manera constante mientras intentas interactuar con Looker, te recomendamos que abres una solicitud de asistencia.