1. 概述
1.1 版本
FineDataLink版本 | 功能說明 |
---|---|
4.0.20.1 | - |
4.0.30 | 支援按照應用維度查看呼叫記錄 |
4.1 | 對於 API 維運方和呼叫方,可在呼叫記錄中對根據存取者IP和呼叫錯誤類型進行篩選 同時對呼叫報錯優化,細化服務端失敗和用戶端失敗的報錯提示分類 |
4.1.4 | 支援批量上線/下線 API |
4.1.6.1 | API管理、呼叫記錄Tab,被挪到「任務維運>資料服務」下 |
4.1.6.5 | API/資料夾支援拖曳排序 |
4.2.1.1 | 1)呼叫記錄中:「狀態與報錯」篩選項不再是下拉框形式,而是以複選按鈕組形式平鋪在頁面上 2)API 管理中:「API狀態」篩選項不再是下拉框形式,而是以複選按鈕組形式平鋪在頁面上 |
4.2.1.3 | 資料服務 API 上線後,支援行動和重新命名 |
4.2.4.3 | API狀態更新為:已上線、未上線 點選 API 右側的 API 列表中新增目錄樹重新整理按鈕 |
4.2.5.4 | API管理:
呼叫記錄:
|
1.2 應用場景
在 API 發佈後,使用者希望能對 API 進行任務管理、監視,查看運作狀態和 API 呼叫情況、批量上下線 API 等。
1.3 功能說明
FineDataLink 支援對發佈的 API 進行任務管理、運作監視和任務監視,查看呼叫情況、批量上下線 API 等。
2. API 列表
API 列表中使用者可查看和編輯所有有 權限 的 API 任務。
1)滑鼠點選某個 API 右側的標籤,可修改 API 名稱、將 API 行動到某個路徑下、將 API 複製到某個路徑下、刪除 API 、匯出 API 。如下圖所示:
注:4.2.4.3 及之後版本,API 列表中新增「目錄樹重新整理」按鈕,可重新整理目錄樹。
各設定項說明如下表所示:
設定項 | 說明 |
---|---|
名稱與描述 | 支援修改 API 名稱和描述:
|
行動到 | 可將 API 行動到指定資料夾中:
|
複製到 | 可將 API 複製到指定資料夾中:
|
匯出 | 詳情參見:API任务导入导出 |
刪除 | 選擇任務,可將其刪除 |
所有使用者均可手動拖曳有權限的 API/資料夾。
拖曳結果對所有使用者生效。
某使用者從上到下看到的 API 為 5、1、7;管理者從上到下看到的 API 為 5、6、1、9、7;該使用者將 7 挪到 5 和 1 之間,管理者側將看到 7 在 1 上面,在 6 下面;即被挪動的 API 緊靠下方的那個目標節點(目標節點為 5 和 1,1為靠下的位置);資料夾也同理。
3. 應用列表
詳情參見:綁定API至應用
4. API管理
4.1 以API任務維度查看API列表
點選「任務維運>資料服務>API管理」,選擇指定的 API 資料夾或者API任務,即可查看到上線 API 數、下線 API 數,如下圖所示:
按照 API 建立時間進行時間區間篩選,同時可以按照 API 上下線狀態、API名稱、建立人進行篩選,查看 API 情況。如下圖所示:
可以在篩選後的任務列表中一鍵查看呼叫記錄 ,如下圖所示:
也可以直接進入API 編輯介面或者發佈 API,如下圖所示:
4.2 以應用維度查看API列表
點選「任務維運>資料服務>API管理>應用」,選擇指定的應用或者資料夾,即可查看到上線 API 數、下線 API 數。如下圖所示:
按照API建立時間對指定資料夾下的應用中 API 任務進行時間區間篩選,同時可以按照API上下線狀態進行篩選,查看 API 情況,如下圖所示:
同時和 4.1 節一樣,也可以在篩選後的任務列表中一鍵查看呼叫記錄、編輯或者發佈 API 。
4.3 批量上線/下線 API
API和應用維度,都支援批量上線/下線 API。
批量選擇需要上線/下線的API,再點選批量上線/批量下線按鈕。如下圖所示:
說明如下:
支援一鍵全選當前頁,執行批量上下線操作。
選擇的API中狀態只有下線,「批量下線」按鈕灰化;若狀態只有上線,「批量上線」按鈕灰化。
使用改寫邏輯,即已上線的 API 繼續上線,上線已下線的 API 。
操作結果會告知使用者。如下圖所示:
5. 呼叫記錄
5.1 以API任務維度查看呼叫記錄
點選「任務維運>資料服務>呼叫記錄」,然後選擇指定的任務或者資料夾,即可查看呼叫成功、呼叫失敗的 API 數量。如下圖所示:
注:FineDataLink 配置 Nginx 轉發後,不影響資料服務模組 API 呼叫記錄呼叫的 IP。
支援根據「API 名稱」和「呼叫IP」篩選呼叫記錄,便於API維護方根據 API 名稱維度和被呼叫方 IP 維度查看呼叫記錄,如下圖所示:
同時可以按照API呼叫時間進行時間區間篩選,同時可以按照呼叫狀態進行篩選呼叫情況,如下圖所示:
呼叫回應錯誤程式碼詳情參見:数据服务错误代码表
4.2.5.4 版本開始,可對呼叫記錄詳情表格進行表頭欄位設定,包括修改欄位順序和隱藏欄位,如下圖所示:
5.2 以API應用維度查看呼叫記錄
點選「資料服務>呼叫記錄」,選擇API,然後選擇指定的應用或者資料夾,即可查看應用中所屬的所有任務的呼叫次數、伺服器端失敗次數、用戶端失敗次數等。如下圖所示:
支援根據「API 名稱」和「呼叫IP」篩選呼叫記錄,便於API維護方根據 API 名稱維度和被呼叫方 IP 維度查看呼叫記錄,如下圖所示:
同時可以按照指定的應用中API呼叫時間進行時間區間篩選,同時可以按照呼叫狀態進行篩選呼叫情況,如下圖所示:
呼叫狀態顯示與5.1 節相同。
4.2.5.4 版本開始,可對呼叫記錄詳情表格進行表頭欄位設定,包括修改欄位順序和隱藏欄位,如下圖所示: