Soluciona problemas de uso de la API

En esta página, se proporciona a los desarrolladores de aplicaciones una descripción general de cómo solucionar problemas del uso de las API de Google y Google Cloud.

Antecedentes

Las APIs de Google son APIs conectadas en red que proporcionan los servicios de Google. Las aplicaciones pueden acceder a las APIs de Google a través de JSON HTTP y gRPC desde diferentes entornos. Recomendamos a los desarrolladores usar las bibliotecas cliente que proporciona Google en sus aplicaciones. Estas bibliotecas implementan una lógica estándar común, como la autenticación y la paginación de listas, lo que reduce en gran medida la sobrecarga de desarrollo y los errores comunes.

Para obtener más información, consulta Explicación de las bibliotecas cliente.

Primeros pasos

Si es la primera vez que usas las APIs de Google, debes seguir la página Cómo comenzar a fin de completar los pasos de preparación para tu aplicación. Primero, debes usar el comando curl -v para enviar solicitudes de prueba a las APIs de Google que desees usar. Te permite experimentar con las APIs de Google sin escribir ningún código. A menudo, puedes resolver muchos problemas antes de comenzar el desarrollo real de la aplicación.

Para obtener más información, consulta Cómo comenzar.

Soluciona problemas con métricas

Las APIs de Google proporcionan métricas de API gratuitas que abarcan aspectos comunes del uso de la API, incluidos el recuento de solicitudes, los errores, las latencias y los tamaños de solicitudes y respuestas. Proporcionan dimensiones detalladas en términos de aplicaciones y ubicaciones. Los desarrolladores pueden descubrir un uso anormal de la API e identificar posibles causas raíz. Por ejemplo, los errores 400 más altos pueden significar que una aplicación actualizada recientemente tiene algunos errores lógicos, o que los tamaños de solicitud y respuesta más altos pueden causar un rendimiento más lento de la aplicación.

Para obtener más información, consulta Supervisa el uso de API.

Soluciona problemas mediante registros

Por motivos de seguridad y privacidad, las APIs de Google no suelen proporcionar registros de API a los desarrolladores de aplicaciones. Recomendamos que los desarrolladores de aplicaciones registren los errores de la API del cliente. Puedes registrar los errores en un almacenamiento local o en una API de registro remoto, como la API de Cloud Logging.

Por lo general, los registros contienen más información sobre los errores que las métricas, como los mensajes de error y los detalles de errores. Son extremadamente útiles y, a menudo, necesarias para solucionar problemas de API. Cuando los desarrolladores detectan algún problema en el uso de la API, pueden consultar los registros a fin de encontrar mensajes y detalles de errores, y usar la información para resolverlos o comunicarse con el equipo de asistencia.

Registros de auditoría de Cloud

Para las actividades sensibles a la seguridad, los productos de Google Cloud pueden generar registros de auditoría que contengan información detallada de las actividades. Son una gran fuente de información para solucionar problemas en el uso de las APIs de Google Cloud. Por ejemplo, la función de ejecución de prueba de los Controles del servicio de VPC genera registros de auditoría para que los administradores evalúen los próximos cambios en las políticas.

Para obtener más información, consulta Registros de auditoría de Cloud.

Cómo resolver errores

Si tienes problemas con el uso de la API de Google y encontraste las métricas y los registros correspondientes, puedes seguir la página Errores de la guía de diseño de las API para resolverlos.

En general, cada error de API tiene 3 datos: código de error, mensaje de error y detalles del error:

  • El código de error permite que las aplicaciones controlen el error en el nivel superior, como reintentarlo después de errores 503 o volver a autenticar a los usuarios después de errores 401.
  • El mensaje de error les permite a los desarrolladores de aplicaciones comprender el error y corregir la lógica de la aplicación.

  • Los detalles del error contienen información adicional que las aplicaciones pueden usar para manejar el error de manera programática.

Para obtener más información, consulta la página Errores.