參考 - API 管理資源記錄結構描述

  • 發行項

適用於：所有 API 管理 層

本文提供 Azure API 管理 GatewayLogs 資源記錄的結構描述參考。 記錄項目也包含 最上層通用結構描述中的欄位。

若要在 API 管理中啟用資源記錄收集，請參閱監視已發佈的 API。

GatewayLogs 結構描述

系統會針對每個 API 要求記錄下列屬性。

屬性 類型​ 描述
ApiId string 目前要求的 API 實體識別碼
ApimSubscriptionId string 目前要求的訂用帳戶實體識別碼
ApiRevision string 目前要求的 API 修訂
BackendId string 目前要求的後端實體識別碼
BackendMethod string 傳送至後端之要求的 HTTP 方法
BackendProtocol string 傳送至後端之要求的 HTTP 通訊協定版本
BackendRequestBody string 後端要求本文
BackendRequestHeaders dynamic 傳送至後端的 HTTP 標頭集合
BackendResponseBody string 後端回應本文
BackendResponseCode int 從後端接收之 HTTP 回應的代碼
BackendResponseHeaders dynamic 從後端接收的 HTTP 標頭集合
BackendTime long 整體後端 I/O (連線、傳送及接收位元組) 所耗費的毫秒數
BackendUrl string 傳送至後端之要求的 URL
Cache string 要求處理中 API 管理快取參與的狀態 (符合、遺漏、無)
CacheTime long 整體 API 管理快取 IO (連線、傳送及接收位元組) 所耗費的毫秒數
ClientProtocol string 連入要求的 HTTP 通訊協定版本
ClientTime long 整體用戶端 IO (連線、傳送及接收位元組) 所耗費的毫秒數
ClientTlsVersion string 用戶端傳送要求所使用的 TLS 版本
錯誤 dynamic 要求處理期間發生的錯誤集合
IsRequestSuccess bool 已完成 HTTP 要求，但回應狀態碼在 2xx 或 3xx 範圍內
LastErrorElapsed long 從閘道收到要求到發生錯誤為止所經過的毫秒數
LastErrorMessage string 錯誤訊息
LastErrorReason string 錯誤原因
LastErrorScope string 包含導致錯誤之原則的原則文件範圍
LastErrorSection string 包含導致錯誤之原則的原則文件區段
LastErrorSource string 導致錯誤的原則或處理內部處理常式命名
方法 string 連入要求的 HTTP 方法
OperationId string 目前要求的作業實體識別碼
ProductId 字串 目前要求的產品實體識別碼
RequestBody string 用戶端要求本文
RequestHeaders dynamic 用戶端所傳送的 HTTP 標頭集合
RequestSize int 在要求處理期間從用戶端接收的位元組數目
ResponseBody string 閘道回應本文
ResponseCode int 傳送至用戶端之 HTTP 回應的狀態碼
ResponseHeaders dynamic 傳送至用戶端的 HTTP 標頭集合
ResponseSize int 在要求處理期間傳送至用戶端的位元組數目
TotalTime long 整體 HTTP 要求 (從 API 管理收到的第一個位元組到用戶端收到的最後一個位元組) 花費的毫秒數
TraceRecords dynamic 追蹤原則所發出的記錄
Url string 連入要求的 URL
UserId string 目前要求的使用者實體識別碼

下一步