En esta página se explica cómo usar el Explorador de APIs para probar los métodos de la API Dataproc Metastore. El Explorador de APIs es un widget asociado a la página de referencia de la API REST de un método. Se muestra como un panel con el título Probar esta API.
El Explorador de APIs es una forma excelente de probar métodos en la API Dataproc Metastore sin tener que escribir código. El widget muestra un formulario con los parámetros de cada método. Rellena el formulario, haz clic en Ejecutar y consulta los resultados.
También puedes ocultar el widget haciendo clic en el botón de cierre situado en la parte superior del panel o ampliarlo a pantalla completa haciendo clic en el botón de pantalla completa.
Antes de empezar
- Sign in to your Google Cloud account. If you're new to Google Cloud, create an account to evaluate how our products perform in real-world scenarios. New customers also get $300 in free credits to run, test, and deploy workloads.
-
In the Google Cloud console, on the project selector page, select or create a Google Cloud project.
Roles required to select or create a project
- Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
-
Create a project: To create a project, you need the Project Creator
(
roles/resourcemanager.projectCreator), which contains theresourcemanager.projects.createpermission. Learn how to grant roles.
-
Enable the Dataproc Metastore API.
Roles required to enable APIs
To enable APIs, you need the Service Usage Admin IAM role (
roles/serviceusage.serviceUsageAdmin), which contains theserviceusage.services.enablepermission. Learn how to grant roles. -
In the Google Cloud console, on the project selector page, select or create a Google Cloud project.
Roles required to select or create a project
- Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
-
Create a project: To create a project, you need the Project Creator
(
roles/resourcemanager.projectCreator), which contains theresourcemanager.projects.createpermission. Learn how to grant roles.
-
Enable the Dataproc Metastore API.
Roles required to enable APIs
To enable APIs, you need the Service Usage Admin IAM role (
roles/serviceusage.serviceUsageAdmin), which contains theserviceusage.services.enablepermission. Learn how to grant roles. - No utilice comillas con los valores de campo de ningún tipo.
- No olvides poner entre comillas las cadenas que aparezcan en los filtros. Usa comillas dobles (
") y no apóstrofos ('). - No utilices barras invertidas ni codificación de URLs en los campos de formulario. Si es necesario, los valores de los campos se codifican mediante URL cuando se ejecuta el método.
- Mira el valor del cuadro de resultados después de ejecutar la llamada. Puede que detectes el problema ahí.
- Indica un valor para el campo pageSize, como
2. De esta forma, se limita la cantidad de datos que se devuelven mientras depuras la llamada a la API.
Acceder al Explorador de APIs
El Explorador de APIs se adjunta a la página de referencia de cada método de la API REST. Para encontrar 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.
Ejecutar 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 rellenan. Puedes ejecutar una solicitud mínima proporcionando solo los argumentos obligatorios.
El método services.create crea un servicio de Dataproc Metastore en un proyecto y una ubicación concretos. Los campos obligatorios son parent
y serviceId. Para crear un servicio, proporciona el número de proyecto y el ID de ubicación de tu proyecto para parent mediante el formulario projects/{projectNumber}/locations/{locationId}. Proporciona el ID de servicio para serviceId.
Los resultados de la invocación del método aparecen en un cuadro debajo del botón Ejecutar. Normalmente, el cuadro tiene un encabezado verde con el código de estado HTTP 200, que indica que la solicitud se ha completado correctamente.
Si el encabezado es rojo y contiene un código de error HTTP, el cuadro contiene el mensaje de error. Consulta los consejos para resolver errores.
Proporcionar parámetros adicionales
La lista de parámetros que ve depende del método al que esté adjunto el widget Explorador de APIs. El método services.create tiene más parámetros que parent y serviceId, pero estos son los únicos obligatorios.
Puede usar el parámetro opcional requestId para especificar un ID de solicitud único que permita al servidor ignorar la solicitud si ya se ha completado.
Usa campos para limitar aún más la salida
De forma predeterminada, el conjunto de parámetros que muestra Explorador de APIs corresponde a los parámetros del método asociado. Sin embargo, el widget Explorador de APIs también tiene un conjunto de campos adicionales que no están disponibles a través del propio método.
Estos parámetros están ocultos en el botón Mostrar parámetros estándar.
Haz clic en este interruptor para mostrar los parámetros adicionales del widget. Haz clic en Ocultar parámetros estándar para que no se muestren.
El más útil de estos parámetros estándar es fields, que te permite seleccionar los campos del resultado devuelto que quieres ver. Esto es muy útil en el panel Explorador de APIs, donde la salida se muestra en un cuadro. A menudo, hay muchos resultados por los que desplazarse.
Consejos
En las siguientes secciones se incluyen consejos sobre el Explorador de APIs.
Recuérdame que cambie {projectNumber} and {locationId}
No olvides sustituir {projectNumber} and {locationId} por el número y el ID de ubicación de tu proyecto. 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, se indican algunos problemas que debes tener en cuenta al usar los formularios del Explorador de APIs. Estos errores pueden provocar errores o aceptarse, pero se tratarán como errores ortográficos en el método de la API:
Marcar URLs para depurar
Cuando obtengas el resultado que quieras, añade a marcadores la URL del Explorador de APIs. Cuando quieras volver a ejecutar el método, pega la URL en tu navegador. Verá que el formulario ya está rellenado con sus valores. Haz los cambios necesarios en los parámetros y haz clic en Ejecutar para volver a ejecutar el método.
Autenticación
En la página Explorador de APIs, encima del botón Ejecutar, hay una sección Credenciales. Por lo general, no es necesario cambiar nada.
El mecanismo de autenticación predeterminado es Google OAuth 2.0.
También hay un interruptor Mostrar ámbitos en la sección Credenciales. Aquí se muestran los ámbitos de Compute Engine que tienes disponibles. De forma predeterminada, todos los ámbitos disponibles están habilitados.