Usa la API de API Monitoring Management

Estás consultando la documentación de Apigee Edge.
Consulta la documentación de Apigee X. Información

Usa la API de administración de supervisión de la API para realizar las siguientes tareas.

Tarea Más información
Administra alertas para la supervisión de API
Administra colecciones para la supervisión de API
Visualiza registros de supervisión de API en niveles diferentes
Visualiza las métricas de supervisión de API

Cuotas de llamada a la API

Todas las API de supervisión de API aplican una cuota que limita la cantidad de veces que puedes llamar a la API por minuto. Por ejemplo, la API de Create collections te limita a seis llamadas por minuto.

No todas las API tienen los mismos límites de cuota. Consulta la documentación de referencia de la API en cada API para determinar su límite.

Usa curl

En los ejemplos de API de este documento, se usa curl a fin de demostrar cómo usar la supervisión de API mediante la API. curl es una herramienta de línea de comandos de código abierto para transferir datos mediante sintaxis de URL que admite protocolos comunes como HTTP y HTTPS. Para obtener más información sobre cómo descargar y usar curl, consulta https://curl.haxx.se/.

En la siguiente tabla, se resumen las opciones de la línea de comandos de curl que se usan en los ejemplos.

Opción Descripción
-d '{}'

--data @filename

Define el cuerpo de la solicitud, que se pasa directamente o se especifica un nombre de archivo.
-H

--header

Define el encabezado de una solicitud. Debes pasar la siguiente información en el encabezado de la solicitud:
  • El token de OAuth 2.0 para la autenticación de usuarios mediante el encabezado Authorization, como se describe en Obtén un token de acceso de OAuth 2.0
  • Los tipos de contenido admitidos por el cliente mediante el encabezado Accept
  • El tipo de contenido del cuerpo de la solicitud que se envía cuando se crea o actualiza un recurso (POST, PATCH, PUT) mediante el encabezado Content-Type
-i Muestra más información, como los encabezados, en la respuesta.
-X Especifica el tipo de solicitud (GET, POST, etc.).

Obtén un token de acceso de OAuth 2.0

Apigee Edge admite OAuth 2.0 para la autenticación de usuarios. Mediante OAuth 2.0, intercambias tus credenciales de Apigee Edge por un token de acceso y un token de actualización que puedes usar para hacer llamadas seguras a la API de Apigee Edge. Una vez que obtienes un token, no necesitas volver a intercambiar tus credenciales hasta que este venza. El token de actualización te permite mantener tu "sesión" con el servidor activa durante un período más largo sin proporcionar tus credenciales. Si deseas obtener más información sobre los tokens de acceso, consulta Usa OAuth2 para acceder a la API de administración.

Con tus credenciales de Apigee Edge, puedes obtener acceso de OAuth 2.0 y tokens de actualización para acceder a los recursos del servicio mediante la utilidad get_token de Apigee.

Para obtener un token de acceso de OAuth 2.0, haz lo siguiente:

  1. Instala la utilidad get_token. Para obtener información sobre cómo instalar la utilidad get_token, consulta Usa get_token.

  2. Ejecuta get_token para obtener un token de acceso de OAuth 2.0.

    La primera vez que ingresas el comando o si caducó el token de actualización, get_token te solicitará el nombre de usuario, la contraseña y el código de seis dígitos de autenticación de dos factores. Ingresa cada valor cuando se le solicite. Si no tienes habilitada la autenticación de dos factores, solo presiona Intro en el mensaje.

  3. Copia el token de OAuth 2.0 y almacénalo en una variable, como ACCESS_TOKEN: 

    export ACCESS_TOKEN=eyJhbGciOiJSUzI1NiJ9.eyJqdGkiOiI2NmQ4MTRiMC01YzZkLTQyZWUtYjlmYi05ZGVhODk5MGRiODIiLCJzdWIiOiJlZjc3YmRhMS05ZWIxLTQyZDgtODg5MC0zODQ3ODg0MzM1OWIiLCJzY29wZSI6WyJzY2ltLmVtYWlscy5yZWFkIiwicGFzc3dvcmQud3JpdGUiLCJhcHByb3ZhbHMubWUiLCJzY2ltLm1lIiwic2NpbS5pZHMucmVhZCIsIm9wZW5pZCIsIm9hdXRoLmFwcHJvdmFscyJdLCJjbGllbnRfaWQiOiJlZGdlY2xpIiwiY2lkIjoiZWRnZWNsaSIsImF6cCI6ImVkZ2VjbGkiLCJncmFudF90eXBlIjoicGFzc3dvcmQiLCJ1c2VyX2lkIjoiZWY3N2JkYTEtOWViMS00MmQ4LTg4OTAtMzg0Nzg4NDMzNTliIiwib3JpZ2luIjoidXNlcmdyaWQiLCJ1c2VyX25hbWUiOiJsbHluY2hAYXBpZ2VlLmNvbSIsImVtYWlsIjoibGx5bmNoQGFwaWdlZS5jb20iLCJyZXZfc2lnIjoiZTViZDc3NjIiLCJpYXQiOjE0NzA3NTMyMDksImV4cCI6MTQ3MDc5NjQwOSwiaXNzIjoiaHR0cHM6Ly9sb2dpbi5lMmUuYXBpZ2VlLm5ldC9vYXV0aC90b2tlbiIsInppZCI6InVhYSIsImF1ZCI6WyJzY2ltIiwicGFzc3dvcmQiLCJvcGVuaWQiLCJlZGdlY2xpIiwiYXBwcm92YWxzIiwic2NpbS5lbWFpbHMiLCJzY2ltLmlkcyIsIm9hdXRoIl19.FF3f1i9eHbBqYjnvBmt9nTtTcyNQBQRDDq2tQ3aRUAzUesLAet7qfBB9QVCvE-zVBn4BiPgRU-iturxPxRMAQ2a34-8oLvgff3x-aALBWkSwbc8PJdWTiPP9VYykoFSJtu9UIN5x0FQEQN_hyurO8D2SrS3uQKNwIyjoJPy4Bps7nb3WqJyKRfXAzf8UptdN7XE0TVqTyBcZGT3OQ2Was0VPfe_dr-wIrywvjNf6FczjdktB1lpKJ2oRXx1n8PuK5FhOQ4wE9VeSsNsMHVcGvJ5W6Tvi61fo2h1w1d4AKvGdERzuVf_XWN00mtcgwsUAuXV0r5H_i3vxcMuUym1XOg

Cuando llamas a la API de supervisión de API, pasa el token de acceso de OAuth 2.0 en el encabezado HTTP mediante el encabezado de autorización. Por ejemplo:


curl -X GET "https://apimonitoring.enterprise.apigee.com/alerts?org=myorg"
   -H "Authorization: Bearer $ACCESS_TOKEN" 
   ...