API 調用日志

簡介

功能簡介

API 調用日誌，是指記錄 API 調用 API key 時的相關操作日誌。日誌中包含了調用 API Key 的 API 名稱、調用時間、API Key 名稱、IP 地址以及返回狀態等內容。

使用場景

當 API 調用失敗時，可以透過 API 調用日誌排查失敗的具體原因，從而改善 API 調用設定，提高開發效率。

預期效果

以查看全部 API 調用日誌為例，效果如下所示：

操作步驟

查詢入口

在「密鑰管理 > API 調用日誌」處，即可對 API 的相關調用操作進行查詢。如下所示：

日誌篩選

API 調用日誌可根據以下條件進行篩選：

日誌資訊

日誌資訊包含了調用 API 的 API 名稱、調用時間、API Key 名稱、IP 地址以及返回狀態等內容。設定好對應的篩選條件後，即可根據篩選條件查詢對應的 API 調用日誌資訊。

以查詢「使用者應用查詢 API」的 API 調用日誌為例，效果如下所示：

返回狀態

返回狀態分為成功和失敗兩種狀態。

當返回狀態為失敗時，在返回狀態處可以同步查看失敗原因。更多錯誤資訊可參見文件：開發指南-錯誤碼。

附註：

除上述開發指南【錯誤碼】中描述外，其他返回失敗情況暫無具體失敗原因。

注意事項

1. API 調用日誌中僅保留近七天的操作日誌。

2. 當密鑰名稱發生修改時，API 調用日誌內歷史日誌中的密鑰名稱不會同步修改。