Usar el Explorador de API

En esta página, se explica cómo usar el Explorador de API para probar los métodos de la API de Dataproc Metastore. El Explorador de API es un widget adjunto a la página de referencia de la API de REST para un método. Aparece como un panel con el título Try this API (Prueba esta API).

El Explorador de API es una excelente manera de probar los métodos en la API de Dataproc Metastore sin tener que escribir ningún código. El widget presenta un formulario que muestra los parámetros para cada método. Completa el formulario, haz clic en Ejecutar y observa los resultados.

También puedes ocultar el widget haciendo clic en el botón para cerrar en la parte superior del panel, o bien expandirlo a pantalla completa haciendo clic en el botón de pantalla completa.

Antes de comenzar

  • Accede a tu cuenta de Google Cloud. Si eres nuevo en Google Cloud, crea una cuenta para evaluar el rendimiento de nuestros productos en situaciones reales. Los clientes nuevos también obtienen $300 en créditos gratuitos para ejecutar, probar y, además, implementar cargas de trabajo.
  • En la página del selector de proyectos de Google Cloud Console, selecciona o crea un proyecto de Google Cloud.

    Ir al selector de proyectos

  • Habilita la API Dataproc Metastore.

    Habilita la API

Accede al Explorador de API

El Explorador de API se adjunta a la página de referencia de cada método de la API de REST. Para encontrar el widget, dirígete a la página de referencia de un método, por ejemplo, la página de referencia de Dataproc Metastore projects.locations.services.create.

Ejecuta una solicitud mínima

La mayoría de los métodos tienen algunos parámetros obligatorios y otros opcionales. Los obligatorios se marcan con una barra roja hasta que se llenen. Puedes ejecutar una solicitud mínima si proporcionas solo los argumentos necesarios.

El método services.create crea un servicio de Dataproc Metastore en un proyecto y una ubicación seleccionados. Los campos obligatorios son los campos parent y serviceId. Para crear un servicio, proporciona el número de proyecto y el ID de ubicación de tu proyecto para el superior con el formulario projects/{projectNumber}/locations/{locationId}. Proporciona el ID de servicio para serviceId.

Probar

Los resultados de la invocación del método aparecen en un cuadro debajo del botón Ejecutar. Por lo general, la casilla tiene un encabezado verde con el código de estado HTTP 200, que indica que la solicitud se realizó de forma correcta.

Si el encabezado es rojo y contiene un código de error HTTP, el cuadro contiene el mensaje de error. Consulta Sugerencias para ver punteros sobre la resolución de errores.

Proporcionar parámetros adicionales

La lista de parámetros que ves depende del método al que se adjunta el widget del Explorador de API. El método services.create tiene más que solo los parámetros parent y serviceId, pero son los únicos parámetros obligatorios.

Puedes usar el parámetro opcional requestId para especificar un ID de solicitud único a fin de permitir que el servidor ignore la solicitud si se completó.

Usa campos para limitar aún más el resultado

De forma predeterminada, el conjunto de parámetros que muestra el Explorador de API corresponde a los parámetros del método asociado. Sin embargo, el widget del Explorador de API también tiene un conjunto de campos adicionales que no están disponibles a través del método.

Estos parámetros están ocultos en el botón de activación Mostrar parámetros estándar.

Haz clic en este botón de activación para exponer los parámetros adicionales de widgets. Haz clic en Ocultar parámetros estándar para ocultarlos.

El más útil de estos parámetros estándar es el parámetro fields, que te permite seleccionar los campos en el resultado que se muestra y que deseas ver. Esto es muy útil en el panel del Explorador de API, en el que el resultado se muestra en un cuadro. A menudo, hay muchos resultados para desplazarse.

Sugerencias

Las siguientes secciones contienen sugerencias del Explorador de API.

Recuerda cambiar {projectNumber} and {locationId}

No olvides reemplazar {projectNumber} and {locationId} por el número de tu proyecto y el ID de la ubicación. Ten en cuenta que la API también acepta el ID del proyecto en lugar del número.

Problemas con los valores

A continuación, encontrará algunos problemas que debe tener en cuenta al utilizar los formularios del Explorador de API. Estos errores pueden generar errores o aceptarse, pero se tratan como errores de ortografía en el método de la API:

  • No use comillas alrededor de los valores de campo de ningún tipo.
  • Asegúrate de entrecomillar las strings que aparecen dentro de los filtros. Usa comillas dobles (") y no apóstrofos (').
  • No uses barras inversas ni codificación de URL en los campos del formulario. Si es necesario, la codificación de URL se realiza en los valores del campo cuando ejecutas el método.
  • Observa el valor en el cuadro de resultados después de ejecutar la llamada. Es posible que notes el problema allí.
  • Proporciona un valor para el campo pageSize, como 2. Esto limita la cantidad de datos que se muestran cuando depuras tu llamada a la API.

Agrega URL a favoritos para depurar

Después de obtener el resultado que deseas, agrega a favoritos la URL del Explorador de API. Cuando quieras volver a ejecutar el método, pega la URL en tu navegador. Verás que el formulario ya se propagó con tus valores. Realiza los cambios necesarios en los parámetros y haz clic en Ejecutar para volver a ejecutar el método.

Authentication

Existe una sección de credenciales en la página del Explorador de API, sobre el botón Ejecutar. Por lo general, no es necesario cambiar nada.

El mecanismo de autenticación predeterminado es Google OAuth 2.0.

También hay un botón de activación Mostrar permisos en la sección Credenciales. Esto te muestra qué alcances de Compute Engine tienes disponibles. De forma predeterminada, todos los alcances disponibles están habilitados.

¿Qué sigue?