Vista geral das operações avançadas da API

Esta página aplica-se ao Apigee e ao Apigee Hybrid.

Veja a documentação do Apigee Edge.

As operações avançadas de API (AAPI Ops) da Apigee fornecem ferramentas para ajudar a garantir que as suas APIs permanecem em funcionamento conforme previsto. As operações da AAPI detetam automaticamente padrões invulgares no tráfego da API, denominados anomalias, como picos na latência ou na taxa de erro. As anomalias podem ser um sinal de problemas com o desempenho da sua API. Quando as operações da AAPI detetam uma anomalia, pode ver os respetivos detalhes no painel de controlo de eventos de anomalias e tomar as medidas adequadas para restaurar o comportamento normal da API.

As operações da API AAPI permitem-lhe:

  • Detetar anomalias: os relatórios de operações da AAPI indicam eventos de API invulgares (anomalias) no painel de controlo de eventos de anomalias.
  • Investigue anomalias: quando a AAPI Ops deteta uma anomalia, pode analisar detalhadamente para saber onde e quando ocorreu o incidente, e o que o desencadeou, para poder resolver rapidamente a situação.
  • Crie alertas de anomalias e configure notificações para que o Apigee lhe envie uma mensagem quando ocorrer um incidente. Pode receber notificações através de vários canais, incluindo email, Slack, PagerDuty ou webhooks.

Para saber mais acerca das anomalias, consulte o artigo Acerca da Deteção de anomalias.

Funções necessárias para operações da API AAPI

Para usar as operações da AAPI, tem de lhe ser atribuídas as seguintes funções:

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

Consulte as funções do Apigee para saber mais.

Ative as operações da API AAPI numa organização

Para usar as operações da API AAPI, tem de as ativar na sua organização. Antes de o fazer, obtenha primeiro uma chave de acesso OAuth 2.0. Em seguida, pode ativar as operações da AAPI através de uma chamada API que transmita o token de acesso.

Veja a configuração atual dos suplementos

Antes de ativar as operações da AAPI, verifique se já está ativada fazendo a seguinte chamada API:

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

em que YOUR_ORG é o nome da sua organização e $TOKEN é a variável de ambiente para uma chave de acesso OAuth. Isto devolve informações básicas sobre a sua organização, que inclui uma secção para suplementos do Apigee que começa com a linha:

"addonsConfig": {

Verifique se esta secção contém uma entrada que começa com "advancedApiOpsConfig", como no seguinte exemplo:

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

Se esta entrada estiver presente, as operações da AAPI já estão ativadas na organização. Caso contrário, tem de o ativar conforme descrito a seguir.

Ative as operações da AAPI

Para ativar as operações da AAPI na organização com a configuração predefinida, emita um pedido POST como o apresentado abaixo.

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

onde <Current add-ons configuration> é a configuração atual dos suplementos. Pode encontrar a configuração atual dos suplementos na resposta à chamada para ver a configuração atual dos suplementos. Por exemplo, se a configuração atual dos suplementos for

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

O comando para ativar as operações da AAPI seria 

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

Depois de enviar o pedido, vê uma resposta semelhante à seguinte:

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

Desative as operações da AAPI na sua organização

Se, por algum motivo, precisar de desativar as operações da AAPI na sua organização, pode fazê-lo emitindo um pedido POST, transmitindo a configuração dos suplementos no corpo do pedido, conforme mostrado abaixo.

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

Segue-se um exemplo da resposta que mostra que a operação está em 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 mais informações, consulte o artigo Configure a API de suplementos da organização.