Visão geral das operações avançadas da API

Mantenha tudo organizado com as coleções Salve e categorize o conteúdo com base nas suas preferências.

Esta é a documentação da Apigee X.
Veja a documentação da Apigee Edge.

As operações avançadas da API da Apigee (operações da API) fornecem ferramentas para ajudar a garantir que as APIs continuem funcionando conforme esperado. As operações da API detectam padrões incomuns automaticamente no tráfego de APIs, chamados de anomalias, como picos de latência ou taxa de erros. As anomalias podem ser um sinal de problemas com o desempenho da API. Quando as operações da API detectam uma anomalia, é possível visualizar os detalhes no painel "Eventos de anomalias" e tomar as medidas necessárias para restaurar o comportamento normal da API.

Com as operações da API, você pode:

  • Detectar anomalias: as operações de API relatam eventos de API incomuns (anomalias) no painel "Eventos de anomalias".
  • Investigar anomalias: quando as operações de AAPI detectam uma anomalia, é possível detalhar onde e quando o incidente ocorreu e o que o acionou, para que você possa corrigir a situação rapidamente.
  • Crie alertas de anomalias e configure notificações para que a Apigee envie uma mensagem quando um incidente ocorrer. É possível receber notificações por vários canais, incluindo e-mail, Slack, PagerDuty ou webhooks.

Para saber mais sobre anomalias, consulte Sobre a detecção de anomalias.

Papéis necessários para as operações da API

Para usar as operações da API, você precisa ter os seguintes papéis:

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

Veja Papéis da Apigee para saber mais.

Ativar as operações AAPI em uma organização

É preciso ativar na sua organização as operações AAPI para poder usar. Antes de fazer isso, consiga um token de acesso do OAuth 2.0. Em seguida, ative as operações da AAPI usando uma chamada de API que transmita o token de acesso.

Ver a configuração dos complementos

Verifique se operações da AAPI já não estão ativadas fazendo a seguinte chamada de 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 de um token de acesso OAuth. Isso retorna informações básicas sobre sua organização, que incluem uma seção para complementos da Apigee que começam com a linha:

"addonsConfig": {

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

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

Se a entrada estiver presente, as operações da AAPI já estão ativadas na organização. Caso contrário, você precisará ativá-la conforme descrito a seguir.

Ativar operações da AAPI

Para ativar as operações da AAPI na organização com a configuração padrão, emita uma solicitação POST, como 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": "true"
      }
      <Current add-ons configuration>
    }
  }'

em que <Current add-ons configuration> é a configuração atual dos complementos. Veja a configuração atual dos complementos na resposta à chamada para ver a configuração atual dos complementos. Por exemplo, se a configuração de complementos atual for

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

o comando para ativar as operações 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 a solicitação, você verá uma resposta como esta:

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

Desativar as operações AAPI na sua organização

Se por algum motivo você precisar desativar a segurança avançada da AAPI na sua organização, emita uma solicitação POST, transmitindo a configuração de complementos no corpo da solicitação, 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>
    }
  }'

Veja a seguir um exemplo de resposta que mostra que a operação está em andamento:

{
  "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 Configurar a API de complementos da organização.