全部產品
Search
文件中心

API Gateway:如何擷取錯誤資訊

更新時間:Jul 13, 2024

所有的 API 請求只要到達了網關,網關就會返回請求結果資訊。

使用者需要查看返回結果的頭部,即 Header 部分。其中 X-Ca開頭的均為網關返回,比較重要訊息是:

// 請求唯一ID,請求一旦進入API Gateway應用後,API Gateway就會產生請求ID並通過回應標頭返回給用戶端,建議用戶端與後端服務都記錄此請求ID,可用於問題排查與跟蹤
X-Ca-Request-Id: 7AD052CB-EE8B-4DFD-BBAF-EFB340E0A5AF
// API Gateway返回的錯誤訊息,當請求出現錯誤時API Gateway會通過回應標頭將錯誤訊息返回給用戶端
X-Ca-Error-Message: Invalid Parameter Required `field1`
// API Gateway系統錯誤碼,當請求出現錯誤被網關攔截後,由API Gateway提供的錯誤碼
X-Ca-Error-Code: I400MP

在應答的Header中獲得X-Ca-Error-CodeX-Ca-Error-Message可以基本明確報錯原因,而X-Ca-Request-Id可以用於在Log Service中查詢請求日誌、通過控制台查詢結果、或提供給技術服務人員進行日誌排查。

X-Ca-Error-Code可以尋找錯誤碼表來擷取更詳細的排錯解釋。