Usar el Explorador de API

En esta página, se describe 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 de 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 el botón Execute (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 puedes expandirlo a pantalla completa haciendo clic en el botón de pantalla completa.

Antes de comenzar

Accede al Explorador de API

El Explorador de API se adjunta a la página de referencia para cada método de API de REST. A fin de buscar el widget, ve 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 completan. Puedes ejecutar una solicitud mínima si proporcionas solo los argumentos necesarios.

El método services.create crea un servicio de Dataproc Metastore en la ubicación y el proyecto elegido. Los campos obligatorios son parent y serviceId. A fin de crear un servicio, proporciona el número del proyecto y el ID de ubicación de tu proyecto para parent con el formulario projects/{projectNumber}/locations/{locationId}. Además, 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, el cuadro tendrá un encabezado verde con el código de estado HTTP 200, lo 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 las Sugerencias que aparecen a continuación para obtener algunos consejos sobre cómo resolver 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 estos 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

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

Estos son algunos problemas que debes tener en cuenta cuando uses los formularios del Explorador de API. Estos pueden causar errores o ser aceptados, pero se tratan como errores de ortografía en el método de la API:

  • No use comillas alrededor de 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 o 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 veas el problema allí.
  • Recomendamos proporcionar 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 desees volver a ejecutar el método, pega la URL en tu navegador. Verás que el formulario ya propagó con tus valores. Realiza los cambios necesarios en los parámetros y haz clic en Ejecutar para ejecutar el método otra vez.

Autenticación

Hay una sección Credenciales en la página del Explorador de API, arriba del botón Ejecutar. Por lo general, no es necesario cambiar nada aquí.

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é permisos de Compute Engine tienes disponibles. De forma predeterminada, todos los permisos disponibles están habilitados.

¿Qué sigue?