Obtenir des informations sur les appels à vos API

Cette page s'applique à Apigee et à Apigee hybrid.

Consultez la documentation d'Apigee Edge.

Cette page explique comment obtenir des informations sur les appels à vos API, y compris:

Le nombre total d'appels passés à toutes les API.
Quantité totale de données traitées par toutes les API.

Ces informations peuvent vous aider à évaluer votre niveau d'abonnement Apigee, comme décrit dans la section Droits d'abonnement.

Remarque:Pour effectuer les appels d'API décrits ci-dessous, vous devez disposer de l'autorisation apigee.environments.getStats. Pour savoir quels rôles Apigee disposent de cette autorisation, consultez la section Rôles Apigee.

Nombre total d'appels passés à toutes les API

Pour connaître le nombre total d'appels passés à toutes les API d'une organisation et d'un environnement pour une période donnée, utilisez un appel d'API Metrics semblable à celui présenté ci-dessous. Le résultat prend en compte les scénarios dans lesquels vous avez associé des proxys en chaîne.

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"

Dans l'appel ci-dessus:

ORG est l'organisation.
ENV correspond à l'environnement.
timeRange correspond à la période du rapport, au format MM/DD/YYYY+HH:MM~MM/DD/YYYY+HH:MM, où la date et l'heure de début, ainsi que la date et l'heure de fin, sont au format MM/DD/YYYY+HH:MM.
$TOKEN est une variable d'environnement définie sur votre jeton d'accès OAuth 2.0, comme décrit dans la section Obtenir un jeton d'accès OAuth 2.0. Pour en savoir plus sur les options curl utilisées dans cet exemple, consultez la section Utiliser curl.

Voici un exemple de réponse à l'appel ci-dessus:

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

Le champ values de la réponse contient le nombre d'appels passés aux API de l'organisation et de l'environnement au cours de la période spécifiée.

Quantité totale de données traitées par toutes les API

Pour connaître la quantité totale de données traitées par toutes les API d'une organisation et d'un environnement pour une période donnée, utilisez deux appels: l'un pour les données de requête et l'autre pour les données de réponse.

Pour connaître la quantité totale de données de requête, utilisez un appel semblable à celui-ci:

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"

Pour obtenir la quantité totale de données de réponse, utilisez un appel semblable à celui-ci:

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"

Les variables de ces appels sont identiques à celles de l'exemple précédent.

Remarque sur le chaînage de proxy

Si un environnement contient plusieurs proxys associés, un appel unique à l'un des proxys est transféré aux autres proxys de la chaîne. Cela augmente le nombre total d'appels d'API et le volume total de données traitées par tous les appels d'API. Les commandes qui renvoient ces informations, affichées dans les sections ci-dessus, tiennent compte de l'association de proxys en chaîne.