Usa 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 Cloud Monitoring. 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). En la siguiente captura de pantalla, se muestra el panel como aparece para un método con un solo parámetro, name:

El widget del Explorador de API

El Explorador de API es una excelente manera de probar métodos en la API de Cloud 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 haciendo clic en los o expandir el widget a pantalla completa haciendo clic en.

Botones ¡Pruébalo!

En la documentación, es posible que veas los botones Pruébalo:

Pruébalo

Cuando haces clic en el botón, se abre el Explorador de API en la página de referencia del método. Por lo general, se propagan algunos parámetros apropiados para el ejemplo. Sin embargo, es posible que debas editar algunos de los parámetros para que coincidan con tu propio proyecto, como el valor de [PROJECT_ID].

Para obtener más información sobre cómo evitar y corregir errores, consulta Solución de problemas.

Acceda 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, consulta la página de referencia de un método, por ejemplo, consulta metricDescriptors.list.

Ejecuta una solicitud

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 después de proporcionar valores para todos los argumentos obligatorios.

El método metricDescriptors.list muestra descriptores para todos los tipos de métricas disponibles en un proyecto. El único parámetro obligatorio es el parámetro name.

Para ejecutar el método metricDescriptors.list, haz lo siguiente:

  1. Haz clic en Pruébalo.
  2. En el parámetro name, ingresa el ID de tu proyecto con el formato projects/[PROJECT_ID]. Asegúrate de reemplazar [PROJECT_ID] por el ID de tu proyecto.
  3. Haz clic en Ejecutar. Para ejecutar el comando, el Explorador de API requiere acceso a tu cuenta. Cuando se te solicite, selecciona una cuenta y haz clic en Permitir. El acceso es por un período limitado y está restringido al método de la API que estás ejecutando.

Los resultados de la invocación del método aparecen en un cuadro que tiene un encabezado verde o rojo. Cuando la solicitud se realiza de forma correcta, el cuadro tiene un encabezado verde con el código de estado HTTP 200. Los resultados de la invocación se encuentran en el cuadro:

El resultado de una invocación del método que se realizó de forma correcta.

Cuando el encabezado es rojo, contiene un código de falla de HTTP y el cuadro contiene el mensaje de error. Para obtener más información sobre cómo resolver errores, consulta Solución de problemas.

Cómo suministrar parámetros adicionales

La lista de parámetros que ves depende del método al que se adjunta el widget del Explorador de API. Por ejemplo, el método metricDescriptors.list tiene más que el parámetro name, pero 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. Para restringir la recuperación a un conjunto más pequeño, usa el parámetro filter.

Por ejemplo, para generar una lista solo de los tipos de métricas cuyo nombre termina con utilization, haz lo siguiente:

  1. Haz clic en Pruébalo.

  2. En el parámetro name, ingresa el ID de tu proyecto con el formato projects/[PROJECT_ID]. Asegúrate de reemplazar [PROJECT_ID] por el ID de tu proyecto.

  3. Asegúrate de que el parámetro filter tenga el valor metric.type=ends_with("utilization").

  4. Haga clic en Ejecutar y complete los diálogos de autorización.

Parámetros estándar

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 parámetros adicionales que no forman parte del método. Para mostrar los parámetros adicionales, haz clic en Showstandard parameters:

Botón de activación “Mostrar parámetros estándar”.

Para ocultar los parámetros adicionales de la pantalla, haz clic en Ocultar parámetros estándar.

El parámetro estándar más útil es el parámetro fields. Este parámetro te permite seleccionar los campos del resultado que deseas ver.

Por ejemplo, si deseas enumerar los descriptores para las métricas que terminan con utilization, se seguirán mostrando muchos resultados. Si solo deseas saber el nombre del tipo de métrica y su descripción, puedes especificar esta restricción mediante el parámetro fields.

Para ver el resultado de la configuración del parámetro fields, haz lo siguiente:

  1. Haz clic en Pruébalo.

  2. En el parámetro name, ingresa el ID de tu proyecto con el formato projects/[PROJECT_ID]. Asegúrate de reemplazar [PROJECT_ID] por el ID de tu proyecto.

  3. Asegúrate de que el parámetro filter tenga el valor metric.type=ends_with("utilization").

  4. Haz clic en Mostrar parámetros estándar y verifica que el parámetro fields tenga el valor metricDescriptors.type,metricDescriptors.description.

  5. Haga clic en Ejecutar y complete los diálogos de autorización.

Cuando se ejecuta esta solicitud, solo se muestra el type (nombre corto) de cada métrica y su description.

Solucionar problemas

En esta sección, se describen los problemas comunes cuando se usa el Explorador de API.

Para obtener más información sobre cómo usar la API de Cloud Monitoring, consulta Soluciona problemas de la API de Cloud Monitoring.

Identificador de proyecto no válido

Si el identificador del proyecto no es válido, la solicitud a la API falla con un error HTTP 400.

Para resolver esta condición, verifica que el texto [PROJECT_ID] se haya reemplazado por el ID de tu proyecto.

Valores de formulario no válidos

Si tu solicitud a la API falla o muestra valores inesperados, verifica todos los parámetros de forma.

Los parámetros del Explorador de API requieren un formato específico. Los errores de formato pueden causar errores o aceptarlos, pero se los debe tratar como errores de ortografía en el método de la API:

  • No use comillas alrededor de los valores de los parámetros de ningún tipo.
  • No uses barras inversas, excepto cuando necesites proteger una substring.

    Por ejemplo, la siguiente muestra es para un método de API en el que ingresas el contenido como JSON, en lugar de completar parámetros de formulario individuales. Debido a que el valor de filter es una string, la substring, k8s_cluster, está protegida por barras invertidas:

    {
      "resourceNames": [...],
      "filter": "resource.type = \"k8s_cluster\""
    }
  • No uses la codificación de URL en el formulario. Si un método de API requiere codificación de URL, el widget realiza la conversión cuando ejecutas el método.

Se muestran demasiados datos

Para limitar la cantidad de resultados que se muestran, en el parámetro pageSize, ingresa un valor, como 2. El parámetro pageSize define la cantidad máxima de resultados que se muestran y está disponible para la mayoría de los métodos de la API.

Si quieres seleccionar campos específicos para mostrar, usa el parámetro fields. Para obtener más información, consulta Parámetros estándar.

Authentication

En la página Explorador de API, hay una sección de Credenciales. Recomendamos que dejes estos campos en los valores predeterminados. El mecanismo de autenticación predeterminado es Google OAuth 2.0.

Si deseas saber qué alcances de la API son necesarios para el método, haz clic en Mostrar permisos. De forma predeterminada, se otorgan todos los permisos necesarios.

Para obtener más información sobre estos conceptos, consulta Control de acceso.