Receba informações sobre chamadas para as suas APIs

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

Veja a documentação do Apigee Edge.

Esta página descreve como obter informações sobre chamadas para as suas APIs, incluindo:

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

Estas informações podem ajudar a avaliar o seu nível de subscrição do Apigee, conforme descrito em Direitos de subscrição.

Nota: para fazer as chamadas API descritas abaixo, tem de ter a autorização apigee.environments.getStats. Para saber que funções do Apigee têm esta autorização, consulte o artigo Funções do Apigee.

Número total de chamadas feitas a todas as APIs

Para encontrar o número total de chamadas feitas a todas as APIs numa única organização e ambiente para um determinado intervalo de tempo, use uma chamada da API Metrics semelhante à apresentada abaixo. O resultado tem em conta cenários em que tem proxies encadeados.

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 intervalo de tempo do relatório, no formato MM/DD/YYYY+HH:MM~MM/DD/YYYY+HH:MM, em que a data e a hora de início e a data e a hora de fim têm o formato MM/DD/YYYY+HH:MM.
• $TOKEN é uma variável de ambiente definida para a sua chave de acesso de OAuth 2.0, conforme descrito em Obter uma chave de acesso de OAuth 2.0. Para informações sobre as opções curl usadas neste exemplo, consulte a secção Usar o curl.

Nota: para encontrar o número total de chamadas feitas às suas APIs, tem de repetir a chamada acima para todos os seus ambientes e organizações.

Segue-se um exemplo da 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 às APIs na organização e no ambiente no intervalo de tempo especificado.

Quantidade total de dados processados por todas as APIs

Para encontrar a quantidade total de dados processados por todas as APIs numa única organização e ambiente para um determinado intervalo de tempo, use duas chamadas: uma para dados de pedidos e outra para dados de respostas.

Nota: 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 de pedidos, 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 a quantidade total de dados de respostas, use uma chamada semelhante à seguinte:

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 nestas chamadas são as mesmas que no exemplo anterior.

Nota: para encontrar a quantidade total de dados processados pelas suas APIs, tem de repetir as chamadas acima para todos os seus ambientes e organizações.

Nota sobre o encadeamento de proxies

Se um ambiente contiver vários proxies encadeados, uma única chamada a um dos proxies é encaminhada para os outros proxies na cadeia. Isto aumenta a contagem total de chamadas API e a quantidade total de dados processados por todas as chamadas API. Os comandos que devolvem estas informações, mostrados nas secções acima, têm em conta o encadeamento de proxies.