全部產品
Search
文件中心

Dataphin:管理營運監控API

更新時間:Oct 01, 2025

為了保障應用能夠正常調用API,同時能夠保護系統,資料服務支援監控API的運行情況,便於及時處理異常指標。本文為您介紹如何監控API。

使用限制

  • 當使用的API Gateway未開通日誌採集時,網關的失敗的調用次數不會計入調用統計,也無法採集調用失敗的日誌,強烈建議使用的網關配置日誌採集以採集完整的日誌資訊

  • 異常分析和訪問趨勢分析根據是否可擷取1分鐘統計日誌和5分鐘統計日誌進行自動切換,系統優先使用1分鐘調用統計。

營運監控入口

  1. 在Dataphin首頁的頂部功能表列,選擇服務 > API營運

  2. 在左側導覽列單擊營運監控,進入營運監控頁面。

  3. 營運監控頁面,查看所選專案下特定時間範圍內的營運監控資料,在右上方選擇所屬服務專案及時間範圍,支援的時間範圍為近十分鐘近24小時近7天自訂(可選擇最近90天)。

查看營運大盤

  1. 營運監控頁面,單擊頂部功能表列的營運大盤頁簽。

  2. 您可以分別查看同步調用和非同步呼叫的營運總覽資料,同步調用和非同步呼叫的營運指標一致,若僅支援其中一種調用方式,將進行說明。

    總覽資料

    描述

    API數核心指標

    發布API數

    指定服務專案內所有發布到市場上的API總數。

    線上API數

    指定服務專案內所有已授權應用且發行的API總數。

    調用API數

    在指定時間段內,指定服務專案內所有調用API的個數。

    調用異常API數

    在指定時間段內,指定服務專案內API調用總時間長度/API調用總次數。

    API調用次數核心指標

    API調用次數

    在指定時間段內,指定服務專案內所有API的調用總次數。

    調用異常次數

    在指定時間段內,指定服務專案內所有API的調用錯誤總次數。

    調用異常率

    在指定時間段內,指定服務專案內所有API的調用錯誤總次數/調用總次數*100%。

    offline異常次數

    在指定時間段內,指定服務專案內API調用錯誤返回offline錯誤總次數。

    offline異常率

    在指定時間段內,指定服務專案內API調用錯誤返回offline錯誤總次數/調用總次數*100%。

    公用API調用

    僅非同步呼叫可查看該指標。在指定時間段內,指定服務專案內公用API的調用次數按照專案層級統計。所依賴的公用API如下:

    • GetJobRequestStatus:擷取API調用的執行狀態。

    • GetJobRequestResult:擷取API調用後返回請求的結果。

    • GetJobExecutionLog:擷取API執行的日誌。

    • CloseJobRequest:完成API的查詢請求。

    • CancelJobRequest:取消API的查詢請求。

查看異常影響分析

查看指定服務專案在指定時間段內所有API調用異常的APP數,包含同步調用和非同步呼叫,可在應用調用分析詳情中查看。

為您展示所選服務專案下所有API的異常影響APP排行TOP10調用異常次數API排行Top10,同時您可以單擊操作列下的查看調用詳情(需在系統配置中開啟調用明細日誌),跳轉至資料服務 > API營運 > 調用日誌頁面查看所選時間範圍內的日誌詳情。

image

image

查看訪問趨勢分析

訪問趨勢分析包括調用異常趨勢調用異常影響趨勢,您可以切換最近1分鐘匯總或最近5分鐘匯總的訪問趨勢分析資料。滑鼠移至上方至異常圖上查看某一時間點的調用次數和調用異常次數。

  • 調用異常趨勢:為您展示所選專案下的API被應用調用的次數及調用異常的次數。

  • 調用異常影響趨勢:為您展示所選專案下API調用異常影響次數及API調用影響的應用數,協助您發現及處理調用異常的API和APP。

    image

公用API趨勢分析

僅非同步呼叫模式可查看公用API趨勢分析,包括訪問趨勢分析異常趨勢分析,您可以切換最近1分鐘匯總或最近5分鐘匯總的公用API趨勢分析資料。滑鼠移至上方至折線圖查看某一時間點的公用API調用次數。

  • 訪問趨勢分析:為您展示當前專案下公用API調用的次數。

  • 異常趨勢分析:為您展示當前專案下公用API調用的異常次數,協助您發現及處理調用異常的公用API。

image

查看API運行情況

  1. 營運監控頁面,單擊API運行分析頁簽。

  2. API運行情況以API為維度為您展示API的名稱及ID、所屬服務專案、調用模式、授權應用數、調用次數、調用異常次數、平均調用時間長度、錯誤率、offline百分比、建立人、最近調用時間。

  3. 您可以對目標API執行如下操作。

    • API影響分析:可查看調用該API的所有應用(APP)資訊,詳情請參見API影響分析

    • 限流設定:僅支援對開發環境下所屬專案的API進行限流設定,防止資源分派不足等情境,詳情請參見限流設定

    • 警示設定:支援對所屬專案的API設定警示設定,可及時接收API運行異常資訊,快速做出響應,詳情請參見警示設定

    • 查看調用日誌:當在系統配置中開啟調用明細日誌時支援該操作。單擊操作列下的查看調用日誌,跳轉至資料服務 > 服務管理 > 調用日誌頁面查看所選時間範圍內的日誌詳情。

image

API影響分析

  1. API運行情況列表中,單擊目標API操作列下的API影響分析

  2. API影響分析的對話方塊中,為您展示調用該API的所有應用(APP)資訊,包括APP的名稱、訪問來源的IP、統計區間、調用次數、異常次數、錯誤率。同時以柱狀圖的形式為您展示Top 10的異常影響APP。

    • 訪問來源的IP:僅包含統計時間內調用次數最多的10個IP。

    • 查看調用日誌:當在系統配置中開啟調用明細日誌時支援該操作。單擊異常次數後的查看調用日誌,跳轉至資料服務 > 營運 > 調用日誌頁面查看所選時間範圍內的日誌詳情。

      image