使用 API Monitoring Management API

您目前查看的是 Apigee Edge 說明文件。
前往 Apigee X 說明文件
info

使用 API 監控管理 API 執行下列工作。

工作 更多資訊
管理 API 監控的快訊
管理 API 監控的集合
查看不同層級的 API Monitoring 記錄
查看 API Monitoring 指標

API 呼叫配額

所有 API Monitoring API 都會強制執行配額,限制每分鐘可呼叫 API 的次數。舉例來說,建立集合 API 每分鐘最多只能呼叫六次。

並非所有 API 的配額上限都相同。如要瞭解各項 API 的限制,請參閱 API 參考文件

使用 curl

本文中的 API 範例使用 curl,說明如何透過 API 使用 API 監控。curl 是開放原始碼的指令列工具,可使用網址語法傳輸資料,並支援 HTTP 和 HTTPS 等常見通訊協定。如要瞭解如何下載及使用 curl,請參閱 https://curl.haxx.se/

下表摘要說明範例中使用的 curl 指令列選項。

選項 說明
-d '{}'

--data @filename

定義要求主體,可直接傳遞或指定檔案名稱。
-H

--header

定義要求標頭。您必須在要求標頭中傳遞下列資訊:
  • 使用 Authorization 標頭進行使用者驗證的 OAuth 2.0 權杖,如「取得 OAuth 2.0 存取權杖」一文所述。
  • 用戶端使用 Accept 標頭支援的內容類型
  • 使用 Content-Type 標頭建立或更新資源 (POSTPATCHPUT) 時,傳送的要求主體內容類型
-i 在回應中顯示更多資訊,例如標頭。
-X 指定要求類型 (GETPOST 等)。

取得 OAuth 2.0 存取權杖

Apigee Edge 支援 OAuth 2.0,可進行使用者驗證。透過 OAuth 2.0,您可以將 Apigee Edge 憑證換成存取權杖和更新權杖,然後使用這些權杖安全地呼叫 Apigee Edge API。取得權杖後,您不需要再次交換憑證,直到權杖到期為止。您可以使用更新權杖,在不提供憑證的情況下,讓與伺服器的「工作階段」維持較長時間。如要進一步瞭解存取權杖,請參閱「使用 OAuth2 存取管理 API」。

您可以使用 Apigee Edge 憑證取得 OAuth 2.0 存取和更新權杖,透過 Apigee 的 get_token 公用程式存取 Apigee Edge 資源。

如要取得 OAuth 2.0 存取權杖,請按照下列步驟操作:

  1. 安裝 get_token 公用程式。如要瞭解如何安裝 get_token 公用程式,請參閱「使用 get_token」。

  2. 執行 get_token 取得 OAuth 2.0 存取權杖。

    第一次輸入指令時,或更新權杖過期時,get_token 會提示您輸入使用者名稱、密碼和六位數的雙重驗證碼。系統出現提示時,請輸入每個值。如果未啟用雙重驗證,只要在提示中按下 Enter 鍵即可。

  3. 複製 OAuth 2.0 權杖,並儲存在變數中,例如 ACCESS_TOKEN

    export ACCESS_TOKEN=eyJhbGciOiJSUzI1NiJ9.eyJqdGkiOiI2NmQ4MTRiMC01YzZkLTQyZWUtYjlmYi05ZGVhODk5MGRiODIiLCJzdWIiOiJlZjc3YmRhMS05ZWIxLTQyZDgtODg5MC0zODQ3ODg0MzM1OWIiLCJzY29wZSI6WyJzY2ltLmVtYWlscy5yZWFkIiwicGFzc3dvcmQud3JpdGUiLCJhcHByb3ZhbHMubWUiLCJzY2ltLm1lIiwic2NpbS5pZHMucmVhZCIsIm9wZW5pZCIsIm9hdXRoLmFwcHJvdmFscyJdLCJjbGllbnRfaWQiOiJlZGdlY2xpIiwiY2lkIjoiZWRnZWNsaSIsImF6cCI6ImVkZ2VjbGkiLCJncmFudF90eXBlIjoicGFzc3dvcmQiLCJ1c2VyX2lkIjoiZWY3N2JkYTEtOWViMS00MmQ4LTg4OTAtMzg0Nzg4NDMzNTliIiwib3JpZ2luIjoidXNlcmdyaWQiLCJ1c2VyX25hbWUiOiJsbHluY2hAYXBpZ2VlLmNvbSIsImVtYWlsIjoibGx5bmNoQGFwaWdlZS5jb20iLCJyZXZfc2lnIjoiZTViZDc3NjIiLCJpYXQiOjE0NzA3NTMyMDksImV4cCI6MTQ3MDc5NjQwOSwiaXNzIjoiaHR0cHM6Ly9sb2dpbi5lMmUuYXBpZ2VlLm5ldC9vYXV0aC90b2tlbiIsInppZCI6InVhYSIsImF1ZCI6WyJzY2ltIiwicGFzc3dvcmQiLCJvcGVuaWQiLCJlZGdlY2xpIiwiYXBwcm92YWxzIiwic2NpbS5lbWFpbHMiLCJzY2ltLmlkcyIsIm9hdXRoIl19.FF3f1i9eHbBqYjnvBmt9nTtTcyNQBQRDDq2tQ3aRUAzUesLAet7qfBB9QVCvE-zVBn4BiPgRU-iturxPxRMAQ2a34-8oLvgff3x-aALBWkSwbc8PJdWTiPP9VYykoFSJtu9UIN5x0FQEQN_hyurO8D2SrS3uQKNwIyjoJPy4Bps7nb3WqJyKRfXAzf8UptdN7XE0TVqTyBcZGT3OQ2Was0VPfe_dr-wIrywvjNf6FczjdktB1lpKJ2oRXx1n8PuK5FhOQ4wE9VeSsNsMHVcGvJ5W6Tvi61fo2h1w1d4AKvGdERzuVf_XWN00mtcgwsUAuXV0r5H_i3vxcMuUym1XOg
    
    

呼叫 API Monitoring API 時,請使用 Authorization 標頭,在 HTTP 標頭中傳送 OAuth 2.0 存取權杖。例如:


curl -X GET "https://apimonitoring.enterprise.apigee.com/alerts?org=myorg"
   -H "Authorization: Bearer $ACCESS_TOKEN" 
   ...