DataWorks的數據服務模塊,提供了通過API消費數據的服務,可以為使用API接收數據的業務提供數據。本文將以場景示例形式,為您介紹如何用DataWorks完成API服務對數據的消費。
前提條件
在開始示例前,請確認您已經通過數據開發DataStudio將數據加工為用戶畫像基本數據。
如果使用的是MaxCompute數據源,請參見簡單用戶畫像分析(MaxCompute版)進行數據加工。
如果使用的是StarRocks數據源,請參見用戶畫像分析(StarRocks版)進行數據加工。
API數據服務不支持Hive數據源,具體以數據源類型下拉列表為準。
創建用戶畫像API服務
通過同步數據與加工數據后,輸出了一張ads_user_info_1d_${數據源類型}
的數據表,該表需要提供給其他可使用API接收數據的業務,DataWorks提供了數據服務API功能,可通過向導模式或腳本模式生成API服務。
步驟一:生成用戶畫像API
本示例在數據服務模塊的API功能中進行操作。
登錄DataWorks控制臺,切換至目標地域后,單擊左側導航欄的數據服務,在下拉框中選擇對應工作空間后單擊進入數據服務。
創建API服務。
在數據服務頁面內,單擊選擇
生成向導模式API。說明生成API方式有向導模式和腳本模式兩種,本示例以向導模式為例。
向導模式生成API可參見通過向導模式生成API文檔。
腳本模式生成API可參見通過腳本模式生成API文檔。
步驟二:配置用戶畫像API
配置詳情。
在向導模式下創建用戶畫像API服務,可通過以下配置實現StarRocks數據源類型的API數據服務,詳情請參見通過向導模式生成API。
模塊
配置項
配置內容
示例內容
選擇表
數據源類型
選擇數據源類型。
說明API數據服務不支持Hive數據源,具體以數據源類型下拉列表為準。
本示例以StarRocks數據源為例。
數據源名稱
選擇已創建的數據源。
使用業務數據源
Doc_StarRocks_Storage_Compute_Tightly_01
。數據源環境
生產環境
開發環境
選擇生產環境。
數據表名稱
選擇 API 使用到的表。
選擇
ads_user_info_1d_StarRocks
表。選擇參數
返回結果分頁
返回結果分頁是否開啟,將影響API的請求參數和返回參數設置。
在右側導航欄的服務資源組中,支持根據資源組類型設置單次請求數據條數上限。詳情請參見配置API。
不開啟返回結果分頁。
設為請求參數
將表內某字段設為請求參數,可多選。
dt
分區字段設置為請求參數。設為返回參數
將表內某字段設為返回參數,可多選。
ads_user_info_1d_StarRocks
全表所有字段設為返回參數。排序字段
排序字段為非必填項。如果您需要對字段進行排序,請首先在選擇參數的列表中選擇所需字段。
不進行排序。
配置服務資源組
完成向導模式API配置后,單擊頁面右側導航欄的服務資源組,可對服務資源進行配置,詳細配置項如下,更多詳情請參見配置API服務資源組。
模塊
配置項
配置內容
資源組類型
方案
獨享服務資源組。
獨享服務資源組
可選擇Serverless資源組(推薦)或獨享服務資源組。
重要如果已購買獨享服務資源組,直接使用即可。
如果沒有任何資源組,則推薦購買Serverless通用型資源組,詳情可參見新增和使用Serverless資源組。
若新購的Serverless資源組在配置服務資源組時為灰色,不可選擇,需要對該資源組的數據服務用途進行配額,具體操作,請參見配額管理。
環境配置
超時時間
配置為30000 ms。
單次請求數據條數上限
配置為2000條。
步驟三:測試發布API
通過測試API來判斷生成的API服務返回的參數是否符合預期,詳情請參見測試API。
完成配置后,單擊保存API,然后單擊進入API測試頁面。
在API測試對話框中,輸入請求參數的值。
單擊開始測試,即可對API進行測試。
發布API,本質上是將API發布至API網關,從而生成在線調用地址,以下為發布至API網關的操作,詳情請參見發布API。
在API測試成功后,在API編輯頁面,單擊提交,會生成一個新API版本,您可以在右側單擊版本查看已經提交的API版本信息。
單擊發布即可成功發布API服務。
API發布后可單擊版本管理處的服務管理或在頁面上切換至管理與維護API。
中對已發布API進行管理。具體詳情可參考