Receber informações sobre chamadas para suas APIs

Esta página se aplica à Apigee e à Apigee híbrida.

Confira a documentação da Apigee Edge.

Nesta página, descrevemos como receber informações sobre chamadas para as APIs, incluindo:

• O número total de chamadas feitas para todas as APIs.
• A quantidade total de dados processados por todas as APIs.

Essas informações podem ajudar você a avaliar o nível de assinatura da Apigee, conforme descrito em Direitos de assinatura.

Observação: para fazer as chamadas de API descritas abaixo, você precisa ter a permissão apigee.environments.getStats. Para saber quais papéis da Apigee têm essa permissão, consulte Papéis da Apigee.

Número total de chamadas feitas para todas as APIs

Para descobrir o número total de chamadas feitas para todas as APIs em uma única organização e em um determinado período, use uma chamada da API Metrics semelhante à mostrada abaixo. O resultado considera cenários em que você associou proxies.

curl -v "https://apigee.googleapis.com/v1/organizations/ORG/environments/ENV/stats/?select=sum(message_count)&timeRange=03/01/2023+00:00~03/31/2023+23:59" \
-H "Authorization: Bearer $TOKEN"

Na chamada acima:

• ORG é a organização.
• ENV é o ambiente.
• timeRange é o período do relatório, no formato MM/DD/YYYY+HH:MM~MM/DD/YYYY+HH:MM, em que as datas e os horários de início e de término estão no formato MM/DD/YYYY+HH:MM.
• $TOKEN é uma variável de ambiente definida para seu token de acesso do OAuth 2.0, conforme descrito em Como receber um token de acesso do OAuth 2.0. Para informações sobre as opções de curl usadas neste exemplo, consulte Como usar curl.

Observação: para descobrir o número total de chamadas feitas para suas APIs, repita a chamada acima para todos os seus ambientes e organizações.

Veja a seguir um exemplo de resposta à chamada acima:

{
  "environments": [
    {
      "metrics": [
        {
          "name": "sum(message_count)",
          "values": [
            "7.44944088E8"
          ]
        }
      ],
      "name": "prod"
    }
  ],
...
}

O campo values da resposta contém o número de chamadas feitas para as APIs na organização e no ambiente no período especificado.

Quantidade total de dados processados por todas as APIs

Para encontrar a quantidade total de dados processados por todas as APIs em uma única organização e em um ambiente em um determinado período, use duas chamadas: uma para os dados de solicitação e outra para os de resposta.

Observação: o total inclui o tamanho dos dados do payload nas chamadas, mas não o tamanho do cabeçalho.

Para encontrar a quantidade total de dados da solicitação, use uma chamada semelhante à seguinte:

curl -v "https://apigee.googleapis.com/v1/organizations/ORG/environments/ENV/stats/?select=sum(request_size)&timeRange=03/01/2023+00:00~03/31/2023+23:59" \
-H "Authorization: Bearer $TOKEN"

Para encontrar os dados de resposta do valor total, use uma chamada semelhante a esta:

curl -v "https://apigee.googleapis.com/v1/organizations/ORG/environments/ENV/stats/?select=sum(response_size)&timeRange=03/01/2023+00:00~03/31/2023+23:59" \
-H "Authorization: Bearer $TOKEN"

As variáveis nessas chamadas são as mesmas do exemplo anterior.

Observação: para encontrar a quantidade total de dados processados pelas APIs, repita as chamadas acima para todos os ambientes e organizações.

Observação sobre encadeamento de proxy

Se um ambiente tiver vários proxies encadeados, uma única chamada para um deles será encaminhada para os outros na cadeia. Isso aumenta a contagem total de chamadas de API e a quantidade total de dados processados por todas as chamadas de API. Os comandos que retornam essas informações, mostrados nas seções acima, consideram o encadeamento de proxy.