Panoramica di Advanced API Operations

Questa pagina si applica ad Apigee e Apigee hybrid.

Visualizza documentazione di Apigee Edge.

Advanced API Operations (AAPI Ops) di Apigee fornisce strumenti per aiutarti a garantire che le tue API rimangano attive e in esecuzione come previsto. Operazioni AAPI automaticamente rileva pattern insoliti nel traffico delle API, chiamati anomalie, quali di latenza o nel tasso di errore. Le anomalie possono essere un segno di problemi con il rendimento dell'API. Quando AAPI Ops rileva un'anomalia, puoi visualizzarne i dettagli nella dashboard Anomaly Events ed eseguire l'azione appropriata per ripristinare il normale comportamento dell'API.

AAPI Ops ti consente di:

  • Rilevare le anomalie: report sulle operazioni AAPI eventi API insoliti (anomalie) nella dashboard Eventi anomali.
  • Esaminare le anomalie: quando AAPI Ops rileva un'anomalia, puoi visualizzare in dettaglio dove e quando si è verificato l'incidente e cosa lo ha attivato, in modo da poter risolvere rapidamente la situazione.
  • Crea avvisi di anomalie e configura le notifiche per fare in modo che Apigee ti invii un messaggio quando si verifica un incidente. Puoi ricevere notifiche tramite più canali, tra cui email, Slack, PagerDuty o webhook.

Per scoprire di più sulle anomalie, consulta Informazioni sul rilevamento di anomalie.

Ruoli obbligatori per AAPI Ops

Per utilizzare AAPI Ops, devi disporre dei seguenti ruoli:

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

Per saperne di più, consulta Ruoli Apigee.

Abilita le operazioni AAPI in un'organizzazione

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

Visualizza la configurazione attuale dei componenti aggiuntivi

Prima di abilitare AAPI Ops, verifica se sono già abilitate eseguendo 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, inclusa una sezione per i componenti aggiuntivi 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à attivato nell'organizzazione. In caso contrario, devi abilitarlo come descritto di seguito.

Attivare AAPI Ops

Per attivare AAPI Ops 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> è la configurazione attuale 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 la configurazione attuale 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"
  }
}

Disattivare AAPI Ops nella tua organizzazione

Se per qualche motivo devi disabilitare le operazioni AAPI nella tua organizzazione, puoi farlo inviando una richiesta POST, passando i componenti aggiuntivi configurazione 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 viene fornito un esempio di 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 l'API Configure organization add-ons.