Panoramica di Advanced API Operations

Questa pagina si applica ad Apigee e Apigee hybrid.

Visualizza la documentazione di Apigee Edge.

La funzionalità Advanced API Operations (AAPI Ops) di Apigee offre strumenti per aiutarti a garantire che le tue API rimangano attive e in esecuzione come previsto. AAPI Ops rileva automaticamente pattern insoliti nel traffico delle API, chiamati anomalie, come picchi di latenza o percentuale di errori. Le anomalie possono essere un segnale di problemi con le prestazioni dell'API. Quando AAPI Ops rileva un'anomalia, puoi visualizzarne i dettagli nella dashboard Eventi di anomalie e intraprendere le azioni appropriate per ripristinare il normale comportamento dell'API.

AAPI Ops ti consente di:

  • Rileva anomalie: AAPI Ops segnala eventi API (anomalie) insoliti nella dashboard Eventi anomalie.
  • Analizzare le anomalie: quando AAPI Ops rileva un'anomalia, puoi visualizzare in dettaglio dove e quando si è verificato l'incidente e cosa l'ha attivato, in modo da poter risolvere rapidamente la situazione.
  • Crea avvisi per anomalie e configura notifiche per consentire ad Apigee di inviarti un messaggio quando si verifica un incidente. Puoi ricevere notifiche attraverso più canali, tra cui email, Slack, PagerDuty o webhook.

Per saperne di più sulle anomalie, consulta l'articolo Informazioni sul rilevamento di anomalie.

Ruoli obbligatori per le operazioni AAPI

Per utilizzare AAPI Ops, devi disporre dei seguenti ruoli:

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

Consulta i ruoli Apigee per saperne di più.

Abilita operazioni AAPI in un'organizzazione

Per utilizzare AAPI Ops, devi abilitarlo nella tua organizzazione. Prima di farlo, devi ottenere un token di accesso OAuth 2.0. Puoi quindi abilitare AAPI Ops utilizzando una chiamata API che trasmette il token di accesso.

Visualizza la configurazione attuale dei componenti aggiuntivi

Prima di abilitare AAPI Ops, verifica se è già abilitato effettuando la seguente chiamata API:

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

dove YOUR_ORG è il nome della tua organizzazione e $TOKEN è la variabile di ambiente per un token di accesso OAuth. Verranno restituite informazioni di base sulla tua organizzazione, tra cui una sezione per i componenti aggiuntivi di Apigee che inizia con la riga:

"addonsConfig": {

Verifica se questa sezione contiene una voce che inizia con "advancedApiOpsConfig", come nell'esempio seguente:

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

Se questa voce è presente, AAPI Ops è già abilitato nell'organizzazione. In caso contrario, devi abilitarlo come descritto di seguito.

Abilita operazioni AAPI

Per abilitare le operazioni AAPI nell'organizzazione con la configurazione predefinita, invia una richiesta POST come quella mostrata di seguito.

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

dove <Current add-ons configuration> è l'attuale configurazione dei componenti aggiuntivi. Puoi trovare la configurazione attuale dei componenti aggiuntivi nella risposta alla chiamata per visualizzare la configurazione attuale dei componenti aggiuntivi. Ad esempio, se l'attuale configurazione dei componenti aggiuntivi è

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

il comando per abilitare le operazioni AAPI sarebbe: 

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

Dopo aver inviato la richiesta, vedrai una risposta simile alla seguente:

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

Disabilita le operazioni AAPI nella tua organizzazione

Se per qualche motivo devi disabilitare le operazioni AAPI nella tua organizzazione, puoi farlo inviando una richiesta POST, passando la configurazione dei componenti aggiuntivi nel corpo della richiesta, come mostrato di seguito.

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

Di seguito è riportato un esempio della risposta che indica che l'operazione è in corso: 

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

Per ulteriori informazioni, consulta la sezione Configurare l'API per i componenti aggiuntivi dell'organizzazione.