使用「Debug」檢視畫面查看訊息資料

本頁適用於 Apigee 和 Apigee Hybrid。

查看 Apigee Edge 說明文件。

課程內容

在本教學課程中，您將學習：

• 查看回應訊息的標頭和內文內容。
• 查看錯誤訊息。

事前準備

開始本教學課程前，請先執行下列操作：

• 請確認您的電腦已安裝 curl，以便透過指令列呼叫 API。
• 完成事前準備一節中的步驟。
• 在 Proxy 中加入 SpikeArrest 政策。SpikeArrest 政策會限制可傳送至 API Proxy 的要求數量。您的 Proxy 必須至少有一個政策。

查看訊息資料

Apigee Proxy 編輯器中的「偵錯」檢視畫面可讓您查看標頭、變數、物件，以及其他詳細資料，例如 API 代理要求和回應流程中的回應時間。您也可以透過「偵錯」檢視畫面，查看要求或回應在 API 代理程式處理時的變化情形。如要進一步瞭解偵錯檢視畫面的詳細說明，請參閱「使用偵錯功能」。

本頁說明如何使用偵錯檢視畫面，查看超出 SpikeArrest 政策費率時會發生什麼事。

注意：您可以在 Google Cloud 主控台和傳統版 UI 中使用「偵錯工具」，並透過 API 執行部分偵錯動作，如以下分頁所述。 Google Cloud 主控台選項包括「Debug v2」(新版) 和「Debug v1」(2022 年 1 月 7 日發布)。您可以在 Google Cloud 主控台和傳統 UI 中切換調試工具的版本。

Cloud 控制台 UI

Debug v2 (新版)

如要在 Cloud 控制台 UI 中使用偵錯檢視畫面，查看超出 SpikeArrest 政策速率時會發生什麼事：

1. 開啟 Cloud Console UI。
2. 選取專案。
3. 依序按一下「Proxy development」>「API Proxies」。
4. 按一下要偵錯的 API 代理程式名稱。
5. 按一下「開發」分頁標籤。
6. 依序點選「政策」>「SpikeArrest」政策。
7. 在編輯窗格中，將「費率」變更為「1pm」。
8. 按一下「儲存」。這樣一來，您就能查看成功和失敗 (超出限制) 的 API 呼叫。
9. 部署更新後的 Proxy。
10. 按一下「Debug」分頁標籤。
11. 按一下「Start Debug Session」。

    在對話方塊中：

    1. 選取要執行偵錯工作階段的環境。

    2. (選用) 在「Filter」下拉式清單中，選取要套用至所建立偵錯工作階段中所有交易的篩選器。預設值為 None (All transactions)，其中包含偵錯資料中的所有交易。

       如要瞭解如何使用篩選器，請參閱「 在偵錯工作階段中使用篩選器」。如要瞭解內建篩選器，請參閱「使用預先定義的篩選器」。

    3. 按一下「啟動」。

12. 使用 curl (或網頁瀏覽器中的網址) 多次 呼叫 API Proxy，直到「Transactions」窗格中顯示至少一個 200 回應和一個 429 回應為止。

    
    注意：超過速率限制的 HTTP 狀態碼為 429 Too many requests。

13. 按一下 429 交易。在「交易流程圖」窗格中，這會顯示流程圖，其中包含帶有錯誤圖示的 SpikeArrest 政策。

    

14. 按一下 「error」圖示。畫面上會顯示「Error Properties」窗格。

    

您可以按一下 「上一個」和 「下一個」按鈕，在流程中切換步驟並查看每個步驟的詳細資料。

如要將整個偵錯工作階段下載為單一文件，請按一下「下載工作階段」。偵錯工作階段會在完成後的 24 小時內刪除，因此如果您想在該時間過後查看工作階段，請先下載該工作階段。

偵錯 v1

1. 在 API Proxy 的「Develop」分頁中，將「Spike Arrest」政策的 <Rate> 編輯為 1pm，然後儲存 Proxy。這樣一來，您就能查看成功和失敗 (超出限制) 的 API 呼叫。
2. 在 Proxy 編輯器中，按一下「Debug」分頁標籤。
3. 按一下「Start Debug Session」。

在對話方塊中：

1. 選取要執行偵錯工作階段的環境。
2. (選用) 在「Filter」下拉式清單中，選取要套用至所建立偵錯工作階段中所有交易的篩選器。預設值為 None (All transactions)，可在偵錯資料中加入所有交易。

   如要瞭解如何使用篩選器，請參閱「在偵錯工作階段中使用篩選器」。如要瞭解內建篩選器，請參閱「使用預先定義的篩選器」。

3. 按一下「啟動」。

4. 使用 curl (或網頁瀏覽器中的網址) 多次呼叫 API 代理伺服器，直到左側窗格中至少顯示一個 200 回應和一個 429 回應為止。

   

   注意：超過頻率限制的 HTTP 狀態碼為 429 Too many requests。
5. 按一下左側窗格中的 429 交易。這會在右側窗格中顯示交易的 甘特圖。

   

   請注意，尖峰流量防範政策有一個資料列，並顯示錯誤圖示。

6. 按一下標示為「錯誤」的資料列。這會在圖表右側顯示錯誤詳細資料。下圖顯示錯誤詳細資料中的「Properties」部分：

   

您可以點選甘特圖下方的「Back」和「Next」按鈕，在流程中移動，並查看每個步驟的詳細資料。

如要將整個偵錯工作階段下載為單一文件，請按一下「下載工作階段」。偵錯工作階段會在完成後的 24 小時內刪除，因此如果您想在該時間過後查看工作階段，請先下載該工作階段。

傳統版 UI

1. 在 API Proxy 的「Develop」分頁中，將「Spike Arrest」政策的 <Rate> 編輯為 1pm，然後儲存 Proxy。這樣一來，您就能查看成功和失敗 (超出限制) 的 API 呼叫。
2. 在 Proxy 編輯器中，按一下「Debug」分頁標籤。
3. 在「Start a debug session」下方，選取要部署 Proxy 的環境。
4. 按一下「Start Debug Session」。

5. 使用 curl (或網頁瀏覽器中的網址) 再次呼叫 API proxy，直到「Debug Transactions」窗格中顯示至少一個 200 回應和一個 429 回應為止。

   curl -v https://YOUR_ENV_GROUP_HOSTNAME/my-proxy

   其中 YOUR ENV_GROUP_HOSTNAME 是環境群組主機名稱。請參閱 找出環境群組主機名稱。

   以下是 200 回應和 429 回應。

   

   注意：超過頻率限制時，預設的 HTTP 狀態碼為 429 Too many requests。

   如果您希望機構中使用的所有 Spike Arrest 政策使用不同的狀態碼 (例如 500)，就必須在機構中設定屬性。如果您是 Cloud 客戶，請與 Google Cloud Customer Care 聯絡，設定該屬性。

6. 按一下左側「交易」窗格中的 200 交易。其偵錯詳細資料會載入至「交易對照圖」下方的主視窗，該視窗會顯示要求/回應圖表。要求流程中顯示「Spike Arrest」圖示。
7. 在流程圖中，按一下回應中右側最遠的圓圈圖示 (如下圖所示)。

   「階段詳細資料」窗格會顯示流程中該階段可用的資料。如果捲動該窗格，您會看到 HTTP 回應標頭和主體內容。

8. 現在來看看 Debug 中的錯誤。

   按一下「交易」窗格中的 429 交易。在主要編輯器視窗中，您會看到只有要求中項目的流程圖，包括有紅色驚嘆號的「Spike Arrest」圖示，表示有錯誤。

   按一下「Spike Arrest」圖示右側的小管狀錯誤圖示，然後查看「Phase Details」窗格中的「spike arrest」違規詳細資料。

   

您可以按一下流程圖中的「Back」和「Next」按鈕，在流程中移動，並查看偵錯詳細資料。

如果您想將整個偵錯工作階段做為單一文件查看，請按一下「Download Debug Session」下載。

詳情請參閱「使用偵錯功能」。