Usar el Explorador de API

En esta guía, se describe cómo usar el Explorador de API para probar los métodos de la API de Monitoring. 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). En la siguiente captura de pantalla, se muestra el panel como aparece para un método con solo un parámetro, name (nombre):

El widget del Explorador de API.

El Explorador de API es una excelente manera de probar los métodos en la API de Monitoring 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 si haces clic en el botón  en la parte superior del panel o expandirlo a pantalla completa con el botón .

Botones ¡Pruébalo!

A través de la documentación, verás los botones Try it! (Pruébalo), como los siguientes, que presentan algunos ejemplos:

Probar

Si haces clic en el botón, se abrirá el Explorador de API en la página de referencia correspondiente y se propagarán los campos correspondientes al ejemplo. Tendrás que editar algunos de los campos para que coincidan con tu propio proyecto, como el valor de [PROJECT_ID].

Consulta las Sugerencias para obtener información adicional sobre cómo evitar y corregir errores.

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. Para encontrar el widget, ve a la página de referencia de un método, por ejemplo, la página de referencia de monitoring.projects.metricDescriptors.list.

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 metricDescriptors.list muestra descriptores para todos los tipos de métricas disponibles en un proyecto. El único campo obligatorio es el campo name. A fin de recuperar esta lista para tu proyecto, proporciona el nombre de tu proyecto para name con el formulario projects/[PROJECT_ID].

Haz clic en el botón que se encuentra a continuación para probarlo, pero antes de hacer clic en el botón Ejecutar en el formulario, debes cambiar [PROJECT_ID] al identificador para tu proyecto:

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. Los resultados de la invocación están en el cuadro:

El resultado de una invocación del método que 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 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 metricDescriptors.list tiene más que solo el parámetro name, sin embargo name es el único parámetro obligatorio.

Cuando proporcionas solo el nombre del proyecto, obtienes todos los descriptores de métricas disponibles en tu proyecto y hay muchos de ellos. Puedes usar el parámetro opcional filter para restringir la recuperación a un conjunto más pequeño.

Por ejemplo, completa los siguientes campos en la página metricsDescriptor.list. Sustituye tu ID del proyecto por [PROJECT_ID], pero proporciona el otro valor como se muestra a continuación:

  • name: projects/[PROJECT_ID]
  • filter: metric.type=ends_with("utilization")

En la ejecución de esta solicitud, solo muestran los descriptores para los tipos de métricas cuyos nombres terminan con utilization.

Probar

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 la opción Show standard parameters (Mostrar parámetros estándar), que aparece sobre la sección Authentication (Autenticación):

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.

Por ejemplo, enumerar los descriptores de las métricas que terminan en utilization aún muestra mucha información. Si solo te interesa el nombre del tipo de métrica y su descripción, puedes usar el campo fields solo para especificar esos campos.

Para ver la diferencia, completa los siguientes campos en la página metricsDescriptor.list. Sustituye tu ID del proyecto por [PROJECT_ID], pero proporciona los otros valores como se muestra a continuación:

  • name, como antes: projects/[PROJECT_ID]
  • filter, como antes metric.type=ends_with("utilization"):
  • fields: metricDescriptors.type,metricDescriptors.description

Cuando se ejecuta esta solicitud, solo se muestra el type (nombre corto) de cada métrica y su description. El siguiente es parte del resultado:

Probar

Sugerencias

Recuerda cambiar [PROJECT_ID]

No olvides reemplazar [PROJECT_ID] por el ID de tu proyecto. Si te olvidas, obtendrás el siguiente resultado:

Mensaje de error cuando olvidas cambiar el PROJECT_ID.

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 ('). Consulta Proporciona parámetros adicionales para ver un ejemplo.
  • 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 Autenticación 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 Autenticación. Esto te muestra qué permisos de Compute Engine tienes disponibles. De forma predeterminada, todos los permisos disponibles están habilitados.

Consulta Control de acceso para obtener más información sobre estos conceptos.

Soluciona problemas

Si aún tienes problemas, consulta Solución de problemas de la API de Monitoring.