API の呼び出しに関する情報を取得する

このページの内容は Apigee と Apigee ハイブリッドに該当します。

Apigee Edge のドキュメントを表示する。

このページでは、API の呼び出しに関する情報を取得する方法について説明します。内容は次のとおりです。

すべての API に対して行われた呼び出しの合計数。
すべての API によって処理されたデータの合計量。

この情報は、サブスクリプションの利用資格で説明されているように、Apigee サブスクリプションレベルを評価する際に役立ちます。

注: 以下で説明する API 呼び出しを行うには、apigee.environments.getStats 権限が必要です。この権限を持つ Apigee のロールについては、Apigee のロールをご覧ください。

すべての API に対して行われた呼び出しの合計数

特定の期間における 1 つの組織と環境内のすべての API に対する呼び出しの合計数を確認するには、次のような Metrics API 呼び出しを使用します。結果には、プロキシをチェーン化したシナリオが考慮されています。

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"

上記の呼び出しで、次のように設定します。

ORG は組織です。
ENV は環境です。
timeRange は、レポートの期間（MM/DD/YYYY+HH:MM~MM/DD/YYYY+HH:MM 形式）です。開始日時と終了日時は MM/DD/YYYY+HH:MM 形式になります。
$TOKEN は、OAuth 2.0 アクセストークンの取得で説明されているように、OAuth 2.0 アクセストークンに設定された環境変数です。この例で使用されている curl オプションの詳細については、curl の使用をご覧ください。

上記の呼び出しに対するレスポンスの例を次に示します。

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

レスポンスの values フィールドには、指定した期間内に組織と環境で API に対して行われた API の呼び出し回数が含まれます。

すべての API によって処理されたデータの合計量

特定の期間に単一の組織と環境内のすべての API によって処理されたデータの合計量を確認するには、2 回の呼び出し（1 つはリクエストデータ用、もう 1 つはレスポンスデータ用）を使用します。

リクエストデータの合計量を確認するには、次のような呼び出しを使用します。

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"

レスポンスデータの合計量を確認するには、次のような呼び出しを使用します。

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"

これらの呼び出しの変数は、前の例と同じです。

プロキシチェーンの注意事項

環境で複数のプロキシがチェーン接続されている場合、一方のプロキシに対する 1 回の呼び出しは、チェーン内の他のプロキシに転送されます。これにより、API 呼び出しの合計数と、すべての API 呼び出しによって処理されたデータの合計量が増加します。前のセクションで説明したこの情報を返すコマンドでは、プロキシチェーンが考慮されます。

API の呼び出しに関する情報を取得する

すべての API に対して行われた呼び出しの合計数

すべての API によって処理されたデータの合計量

プロキシ チェーンの注意事項

プロキシチェーンの注意事項