教學課程：使用要求追蹤對 API 進行偵錯
適用於：取用 |開發人員 |基本 |標準 |進階版
本教學課程說明如何在 Azure API 管理中檢查 (追蹤) 要求處理。 追蹤可協助您針對 API 進行偵錯和疑難排解。
在本教學課程中，您會了解如何：
- 追蹤範例呼叫
- 檢閱要求處理步驟
注意
目前，基本 v2 和標準 v2 層不支援 API 要求追蹤。
必要條件
- 了解 Azure API 管理術語。
- 完成下列快速入門：建立 Azure API 管理執行個體。
- 請完成下列教學課程：匯入和發佈您的第一個 API。
確認允許追蹤設定
若要追蹤要求處理，您必須為用來偵錯 API 的訂用帳戶啟用 [允許追蹤] 設定。 若要在入口網站中檢查：
瀏覽至您的 API 管理執行個體，然後選取 [訂用帳戶] 以檢閱設定。
如果未對您使用的訂用帳戶啟用追蹤，請選取訂用帳戶，並啟用 [允許追蹤]。
警告
- 僅允許追蹤用於偵錯用途的訂用帳戶。 與未經授權的使用者共用允許追蹤的共用訂用帳戶金鑰，可能會揭露追蹤記錄中包含的敏感性資訊，例如金鑰、存取權杖、密碼、內部主機名稱和 IP 位址。
- 在測試控制台中，API 管理 在訂用帳戶上啟用追蹤 1 小時後自動停用追蹤。
追蹤呼叫
登入 Azure 入口網站，然後瀏覽至您的 API 管理執行個體。
選取 [API]。
選取 API 清單中的 [Demo Conference API]。
選取 [測試] 索引標籤。
選取 GetSpeakers 作業。
(選擇性) 選取「眼睛」圖示，檢查要求中使用的 Ocp-Apim-Subscription-Key 標頭的值。
提示
您可以在入口網站中擷取另一個訂用帳戶的金鑰，以覆寫 Ocp-Apim-Subscription-Key 的值。 選取 [訂用帳戶]，然後開啟另一個訂用帳戶的操作功能表 (...)。 選取 [顯示/隱藏金鑰]，並複製其中一個金鑰。 您也可以視需要重新產生金鑰。 然後，在測試主控台中選取 [+ 新增標頭]，以新增具有新金鑰值的 Ocp-Apim-Subscription-Key 標頭。
選取 [追蹤]。
如果您的訂用帳戶尚未允許追蹤，而您想要追蹤呼叫，系統會提示您啟用該功能。
您也可以選擇傳送要求而不追蹤。
檢閱追蹤資訊
在呼叫完成後，移至 [HTTP 回應] 中的 [追蹤] 索引標籤。
選取下列任一連結，以跳至詳細的追蹤資訊：輸入、後端、輸出、發生錯誤時。
輸入 - 顯示從呼叫者接收到的原始要求 API 管理，以及套用至要求的原則。 例如，如果您在教學課程：轉換及保護您的 API 中新增原則，則這些原則會顯示在此。
後端 - 顯示 API 管理傳送至 API 後端的要求及其接收的回應。
輸出 - 顯示回應在傳回至呼叫者之前套用的所有原則。
發生錯誤時 - 顯示在處理要求期間發生的錯誤，以及套用至錯誤的原則。
提示
每個步驟也會顯示 API 管理收到要求後耗用的時間。
在 [訊息] 索引標籤上，ocp-apim-trace-location 標頭會顯示儲存在 Azure Blob 儲存體中的追蹤資料所在的位置。 如有需要，請移至此位置以取得追蹤。 您可以存取 24 小時內的追蹤資料。
使用 Ocp-Apim-Trace 標頭啟用追蹤
使用 curl、REST 用戶端 (例如 Postman) 或用戶端應用程式來對「API 管理」提出要求時，透過新增下列要求標頭來啟用追蹤：
- Ocp-Apim-Trace：將值設定為
true - Ocp-Apim-Subscription-Key：將值設定為已啟用追蹤之訂用帳戶的金鑰，以允許存取 API
回應會包含 Ocp-Apim-Trace-Location 標頭，其中包含 Azure Blob 儲存體中追蹤資料位置的 URL。
如需自訂追蹤資訊的相關資訊，請參閱追蹤原則。
下一步
在本教學課程中，您已了解如何：
- 追蹤範例呼叫
- 檢閱要求處理步驟
前進到下一個教學課程：