Panoramica di Advanced API Operations

Questa pagina si applica a Apigee e Apigee ibridi.

Visualizza documentazione di Apigee Edge.

La soluzione Advanced API Operations (AAPI Ops) di Apigee offre strumenti che ti aiutano garantire che le 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 un segnale di problemi con le prestazioni dell'API. Quando AAPI Ops rileva un'anomalia, puoi visualizzarne i dettagli nella dashboard Eventi anomalia. intraprendere le azioni appropriate 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.
  • Analizzare le anomalie: quando le operazioni AAPI rilevano un'anomalia, puoi visualizzare in dettaglio le anomalie dove e quando si è verificato l'incidente, e cosa lo ha causato, in modo da poter risolvere rapidamente la situazione.
  • Creare avvisi di anomalia e configurare le notifiche per fare in modo che Apigee ti invii un messaggio quando si verifica un incidente. Puoi ricevere le notifiche su più canali, tra cui email, Slack, PagerDuty, o webhook.

Per ulteriori informazioni sulle anomalie, consulta Informazioni sul rilevamento di anomalie.

Ruoli richiesti per le operazioni AAPI

Per utilizzare AAPI Ops, devi disporre dei seguenti ruoli:

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

Vedi i ruoli Apigee per saperne di più.

Abilita le operazioni AAPI in un'organizzazione

Per utilizzare AAPI Ops, devi abilitarlo 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 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 è il una variabile di ambiente per Token di accesso OAuth. Vengono restituite informazioni di base sulla tua organizzazione, che include 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, le operazioni AAPI sono già abilitate 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 un Richiesta POST simile a 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> sono i componenti aggiuntivi correnti configurazione. Puoi trovare la configurazione attuale dei componenti aggiuntivi in risposta alla chiamata a visualizzare l'attuale configurazione dei componenti aggiuntivi. Ad esempio, se l'attuale configurazione dei componenti aggiuntivi sono

"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 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 saperne di più, consulta Configurare l'API dei componenti aggiuntivi dell'organizzazione.