Présentation des opérations d'API avancées

Cette page s'applique à Apigee et à Apigee hybrid.

Consultez la documentation d'Apigee Edge.

La solution Advanced API Operations (AAPI Ops) d'Apigee fournit des outils pour vous aider à assurer le bon fonctionnement de vos API. AAPI Ops détecte automatiquement les schémas inhabituels du trafic de l'API, appelés anomalies, comme les pics de latence ou de taux d'erreur. Les anomalies peuvent être un signe de problèmes liés aux performances de votre API. Lorsque les Opérations d'API Avancées détectent une anomalie, vous pouvez en afficher les détails dans le tableau de bord des événements d'anomalies et prendre les mesures appropriées pour restaurer le comportement normal de l'API.

Les opérations d'API vous permet d'effectuer les tâches suivantes :

  • Détecter les anomalies : les opérations d'API avancées signalent des événements d'API inhabituels (anomalies) dans le tableau de bord "Événements d'anomalies".
  • Examiner les anomalies : lorsque les opérations d'API avancées détectent une anomalie, vous pouvez en afficher le détail pour savoir où et quand l'incident s'est produit, et déterminer ce qui l'a déclenché afin de pouvoir rapidement résoudre le problème.
  • Créer des alertes d'anomalies et configurer des notifications pour qu'Apigee vous envoie un message en cas d'incident. Vous pouvez recevoir des notifications via plusieurs canaux, comme les e-mails, Slack, PagerDuty ou les webhooks.

Pour en savoir plus sur les anomalies, consultez la section À propos de la détection d'anomalies.

Rôles requis pour les opérations d'API avancées

Pour utiliser les opérations d'API avancées, vous devez disposer des rôles suivants :

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

Consultez la section Rôles Apigee pour en savoir plus.

Activer AAPI Ops dans une organisation

Pour utiliser AAPI Ops, vous devez l'activer dans votre organisation. Avant cela, commencez par obtenir un jeton d'accès OAuth 2.0. Vous pouvez ensuite activer AAPI Ops à l'aide d'un appel d'API qui transmet le jeton d'accès.

Afficher la configuration actuelle des modules complémentaires

Avant d'activer l'AAPI Ops, vérifiez si elle est déjà activée en effectuant l'appel d'API suivant :

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

où YOUR_ORG est le nom de votre organisation et $TOKEN est la variable d'environnement d'un jeton d'accès OAuth. Cela renvoie des informations de base sur votre organisation, qui incluent une section pour les modules complémentaires Apigee commençant par la ligne suivante :

"addonsConfig": {

Vérifiez si cette section contient une entrée commençant par "advancedApiOpsConfig", comme dans l'exemple suivant :

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

Si cette entrée est présente, l'AAPI Ops est déjà activée dans l'organisation. Si ce n'est pas le cas, vous devez l'activer comme décrit ci-dessous.

Activer AAPI Ops

Pour activer AAPI Ops dans l'organisation avec la configuration par défaut, envoyez une requête POST comme celle présentée ci-dessous :

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>
    }
  }'

où <Current add-ons configuration> est la configuration actuelle des modules complémentaires. Celle-ci est indiquée dans la réponse à l'appel permettant d'afficher la configuration actuelle des modules complémentaires. Par exemple, si la configuration actuelle des modules complémentaires est :

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

la commande permettant d'activer AAPI Ops serait la suivante : 

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"
      }
    }
  }'

Une fois la requête envoyée, une réponse semblable à celle-ci s'affiche :

{
  "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"
  }
}

Désactiver AAPI Ops dans votre organisation

Si, pour une raison quelconque, vous devez désactiver AAPI Ops dans votre organisation, vous pouvez envoyer une requête POST en transmettant la configuration des modules complémentaires dans le corps de votre requête, comme indiqué ci-dessous.

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>
    }
  }'

Voici un exemple de réponse indiquant que l'opération est en cours : 

{
  "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"
  }
}

Pour en savoir plus, consultez la page Configurer l'API de modules complémentaires de l'organisation.