全部產品
Search
文件中心

DataWorks:配置API過濾器(函數)

更新時間:Dec 06, 2024

資料服務支援您編寫函數,並將函數關聯至API,使得函數可以作為API的過濾器使用,對API的請求參數或返回結果進行加工處理。本文為您介紹函數功能。

使用限制

  • 您需要購買DataWorks基礎版及以上版本,才可以使用過濾器功能。

  • Python函數正在改造中,暫不支援建立、複製和發布新的Python函數。如需使用函數作為API過濾器,建議您使用Aviator函數類型。詳情請參見建立Aviator函數

注意事項

  • 當使用函數作為API過濾器時,前置過濾器和後置過濾器的函數類型需要保持一致,即均選擇Aviator函數類型或Python函數類型。暫不支援對同一API的前置和後置過濾器選擇不同的函數類型。

  • 基於安全和效能等因素的評估,Aviator函數需要運行在獨享資料服務資源群組中。

    • 當您編輯、測試函數時,需要對函數綁定獨享資料服務資源群組。詳情請參見建立函數

    • 當您在API開發時啟用了過濾器並關聯了目標函數,需要對API綁定獨享資料服務資源群組。詳情請參見通過嚮導模式產生API

功能介紹

資料服務支援的函數類型包括Aviator函數、Python函數,您可以在資料服務中建立函數測試函數發布函數,發布後的函數可被進一步關聯至API,作為API的過濾器,對API的請求參數或返回結果進行加工處理,從而實現API的複雜查詢需求,靈活適配各類業務情境。詳情請參見使用函數作為API過濾器

  • 如果將函數設定為API的前置過濾器,當API被調用時,函數可以對API的請求參數進行預先處理。

  • 如果將函數設定為API的後置過濾器,當API被調用時,函數可以對API的返回結果進行二次加工和改造。

常見情境的程式碼範例請參見:使用Aviator函數作為過濾器的最佳實務