取得 API 呼叫的相關資訊

本頁內容適用於 ApigeeApigee Hybrid

查看 Apigee Edge 說明文件。

本頁說明如何取得 API 呼叫相關資訊,包括:

這項資訊可協助您評估 Apigee 訂閱方案等級,詳情請參閱「 訂閱授權」。

對所有 API 進行的呼叫總數

如要找出特定時間範圍內,單一機構和環境中所有 API 的呼叫總數,請使用類似下方的 Metrics API 呼叫。結果會考量您串連多個 Proxy 的情境。

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 處理的資料總量,請發出兩次呼叫:一次用於要求資料,另一次用於回應資料。

如要找出要求資料的總量,請使用類似下列的呼叫:

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"

這些呼叫中的變數與上一個範例相同。

Proxy 鏈結注意事項

如果環境包含多個串連的 Proxy,對其中一個 Proxy 的單一呼叫會轉送至鏈結中的其他 Proxy。這會增加 API 呼叫總數,以及所有 API 呼叫處理的資料總量。傳回這項資訊的指令 (如上節所示) 會將 Proxy 鏈結納入考量。