Descripción general de Advanced API Operations

Esta página se aplica a Apigee y Apigee Hybrid.

Consulta la documentación de Apigee Edge.

Advanced API Operations (AAPI Ops) de Apigee proporciona herramientas que te ayudan a asegurarte de que tus APIs estén disponibles y funcionen según lo previsto. AAPI Ops detecta automáticamente patrones inusuales en el tráfico de las APIs (llamados anomalías), como picos en la latencia o en la tasa de errores. Las anomalías pueden ser un signo de problemas con el rendimiento de tu API. Cuando el equipo de Operaciones de las APIs de Google detecta una anomalía, puedes ver sus detalles en el panel de control de eventos anómalos y tomar las medidas oportunas para restaurar el comportamiento normal de la API.

Las operaciones de AAPI te permiten hacer lo siguiente:

  • Detectar anomalías: AAPI Ops informa de eventos de API inusuales (anomalías) en el panel de control Eventos anómalos.
  • Investigar anomalías: cuando AAPI Ops detecta una anomalía, puedes desglosarla para saber dónde y cuándo se produjo el incidente, así como qué lo desencadenó, para poder solucionar la situación rápidamente.
  • Crea alertas de anomalías y configura notificaciones para que Apigee te envíe un mensaje cuando se produzca un incidente. Puedes recibir notificaciones a través de varios canales, como el correo electrónico, Slack, PagerDuty o webhooks.

Para obtener más información sobre las anomalías, consulte el artículo Acerca de la detección de anomalías.

Roles necesarios para las operaciones de la API

Para usar las operaciones de la API de AAPI, debes tener asignados los siguientes roles:

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

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

Habilitar las operaciones de las APIs de Apigee en una organización

Para usar las operaciones de la API de AA, debes habilitarlas en tu organización. Antes de hacerlo, obtén un token de acceso de OAuth 2.0. Después, puedes habilitar las operaciones de la API de Android Advertising mediante una llamada a la API que transfiera el token de acceso.

Ver la configuración actual de los complementos

Antes de habilitar las operaciones de AAPI, comprueba si ya están habilitadas haciendo 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"

donde YOUR_ORG es el nombre de tu organización y $TOKEN es la variable de entorno de un token de acceso de OAuth. Esta llamada devuelve información básica sobre tu organización, que incluye una sección para los complementos de Apigee que empieza con la línea:

"addonsConfig": {

Comprueba si esta sección contiene una entrada que empiece por "advancedApiOpsConfig", como en el siguiente ejemplo:

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

Si esta entrada está presente, AAPI Ops ya está habilitado en la organización. Si no es así, debe habilitarla como se describe a continuación.

Habilitar operaciones de AAPI

Para habilitar las operaciones de las APIs de Android en la organización con la configuración predeterminada, envía 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>
    }
  }'

donde <Current add-ons configuration> es la configuración actual de los complementos. Puedes consultar 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 las operaciones de la API de Android 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"
  }
}

Inhabilitar las operaciones de las APIs de AA en tu organización

Si por algún motivo necesitas inhabilitar las operaciones de las APIs de AA en tu organización, puedes hacerlo enviando una solicitud POST, pasando la configuración de los complementos en el cuerpo de la solicitud, tal 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 muestra un ejemplo de la respuesta que indica 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"
  }
}

Para obtener más información, consulta la API Configure organization add-ons.