Descripción general de Advanced API Operations

Organiza tus páginas con colecciones Guarda y categoriza el contenido según tus preferencias.

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

Las operaciones avanzadas de API (AAPI Ops) de Apigee proporcionan herramientas para ayudarte a garantizar que tus API se mantengan en funcionamiento según lo previsto. El funcionamiento de AAPI Ops detecta automáticamente patrones inusuales en el tráfico de API, llamados anomalías, como aumentos de latencia o tasa de error. Las anomalías pueden ser un signo de problemas en el rendimiento de la API. Cuando las operaciones de AAPI detectan una anomalía, puedes ver los detalles en el panel de eventos de anomalías y tomar las medidas adecuadas para restablecer el comportamiento normal de la API.

AAPI Ops te permite hacer lo siguiente:

  • Detectar anomalías: AAPI Ops informa sobre eventos inusuales de API (anomalías) en el panel Eventos de anomalía.
  • Investigar las anomalías: Cuando AAPI Ops detecta una anomalía, puedes desglosar para saber dónde y cuándo ocurrió el incidente, y qué lo activó, a fin de permitirte solucionar la situación con rapidez.
  • Crea alertas de anomalías y configura notificaciones para que Apigee te envíe un mensaje cuando ocurra un incidente. Puedes recibir notificaciones a través de varios canales, incluidos el correo electrónico, Slack, PagerDuty o webhooks.

Para obtener más información sobre las anomalías, consulta Acerca de la detección de anomalías.

Funciones obligatorias para AAPI Ops

Para usar AAPI Ops, se te deben asignar los siguientes roles:

  • roles/apigee.readOnlyAdmin
  • roles/logging.viewer
  • roles/monitoring.viewer

Consulta los roles de Apigee para obtener más información.

Habilita AAPI Ops en una organización

Para usar AAPI Ops, debes habilitarla en tu organización. Antes de hacerlo, obtén un token de acceso de OAuth 2.0. Luego, puedes habilitar AAPI Ops mediante una llamada a la API que pase el token de acceso.

Visualiza la configuración actual de complementos

Antes de habilitar AAPI Ops, verifica si ya están habilitadas mediante la siguiente llamada a la API:

curl "https://apigee.googleapis.com/v1/organizations/YOUR_ORG" \
  -X GET \
  -H "Content-type: application/json" \
  -H "Authorization: Bearer $TOKEN"

En el ejemplo anterior, YOUR_ORG es el nombre de tu organización y $TOKEN es la variable de entorno para un token de acceso de OAuth. Esto muestra información básica sobre tu organización, que incluye una sección para los complementos de Apigee que comienza con la siguiente línea:

"addonsConfig": {

Verifica si esta sección contiene una entrada que comienza con "advancedApiOpsConfig", como en el siguiente ejemplo:

"advancedApiOpsConfig": {
          "enabled": "true"
      }

Si esta entrada está presente, AAPI Ops ya están habilitadas en la organización. De lo contrario, debes habilitarla como se describe a continuación.

Habilita AAPI Ops

Para habilitar AAPI Ops en la organización con la configuración predeterminada, emite una solicitud POST como la que se muestra a continuación.

curl "https://apigee.googleapis.com/v1/organizations/ORG:setAddons" \
  -X POST \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-type: application/json" \
  -d '{
    "addonsConfig": {
      "advancedApiOpsConfig": {
          "enabled": "true"
      }
      <Current add-ons configuration>
    }
  }'

En el ejemplo anterior, <Current add-ons configuration> es la configuración actual de los complementos. Puedes encontrar la configuración actual de los complementos en la respuesta a la llamada para ver la configuración actual de los complementos. Por ejemplo, si la configuración actual de los complementos es

"addonsConfig": {
    "integrationConfig": {
        "enabled":"true"
     },
    "monetizationConfig": {
        "enabled":"true"
     }
  },

el comando para habilitar AAPI Ops sería

curl "https://apigee.googleapis.com/v1/organizations/YOUR_ORG:setAddons" \
  -X POST \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-type: application/json" \
  -d '{
    "addonsConfig": {
      "advancedApiOpsConfig": {
          "enabled": "true"
      },
    "integrationConfig": {
          "enabled": "true"
      },
    "monetizationConfig": {
          "enabled": "true"
      }
    }
  }'

Después de enviar la solicitud, verás una respuesta como la siguiente:

{
  "name": "organizations/apigee-docs-d/operations/0718a945-76e0-4393-a456-f9929603b32c",
  "metadata": {
    "@type": "type.googleapis.com/google.cloud.apigee.v1.OperationMetadata",
    "operationType": "UPDATE",
    "targetResourceName": "organizations/apigee-docs-d",
    "state": "IN_PROGRESS"
  }
}

Inhabilita AAPI Ops en tu organización

Si, por algún motivo, necesitas inhabilitar AAPI Ops en tu organización, puedes hacerlo mediante la emisión de una solicitud POST y el paso de la configuración de complementos en el cuerpo de la solicitud, como se muestra a continuación.

curl "https://apigee.googleapis.com/v1/organizations/$ORG:setAddons" \
  -X POST \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-type: application/json" \
  -d '{
    "addonsConfig": {
      "advancedApiOpsConfig`": {
          "enabled": "false"
      }
     <Include current add-ons configuration>
    }
  }'

A continuación, se ofrece un ejemplo de la respuesta que muestra que la operación está en curso:

{
  "name": "organizations/$ORG/operations/06274ffb-8940-41da-836d-781cba190437",
  "metadata": {
    "@type": "type.googleapis.com/google.cloud.apigee.v1.OperationMetadata",
    "operationType": "UPDATE",
    "targetResourceName": "organizations/$ORG",
    "state": "IN_PROGRESS"
  }
}

Si deseas obtener más información, consulta Configura la API de complementos de la organización.