API數(shù)據(jù)服務(wù)
DataWorks的數(shù)據(jù)服務(wù)模塊，提供了通過(guò)API消費(fèi)數(shù)據(jù)的服務(wù)，可以為使用API接收數(shù)據(jù)的業(yè)務(wù)提供數(shù)據(jù)。本文將以場(chǎng)景示例形式，為您介紹如何用DataWorks完成API服務(wù)對(duì)數(shù)據(jù)的消費(fèi)。
前提條件
在開(kāi)始示例前，請(qǐng)確認(rèn)您已經(jīng)通過(guò)數(shù)據(jù)開(kāi)發(fā)DataStudio將數(shù)據(jù)加工為用戶畫(huà)像基本數(shù)據(jù)。
如果使用的是MaxCompute數(shù)據(jù)源，請(qǐng)參見(jiàn)簡(jiǎn)單用戶畫(huà)像分析（MaxCompute版）進(jìn)行數(shù)據(jù)加工。
如果使用的是StarRocks數(shù)據(jù)源，請(qǐng)參見(jiàn)用戶畫(huà)像分析（StarRocks版）進(jìn)行數(shù)據(jù)加工。
API數(shù)據(jù)服務(wù)不支持Hive數(shù)據(jù)源，具體以數(shù)據(jù)源類型下拉列表為準(zhǔn)。
創(chuàng)建用戶畫(huà)像API服務(wù)
通過(guò)同步數(shù)據(jù)與加工數(shù)據(jù)后，輸出了一張ads_user_info_1d_${數(shù)據(jù)源類型}的數(shù)據(jù)表，該表需要提供給其他可使用API接收數(shù)據(jù)的業(yè)務(wù)，DataWorks提供了數(shù)據(jù)服務(wù)API功能，可通過(guò)向?qū)Ｊ?/b>或腳本模式生成API服務(wù)。
步驟一：生成用戶畫(huà)像API
本示例在數(shù)據(jù)服務(wù)模塊的API功能中進(jìn)行操作。
登錄DataWorks控制臺(tái)，切換至目標(biāo)地域后，單擊左側(cè)導(dǎo)航欄的，在下拉框中選擇對(duì)應(yīng)工作空間后單擊進(jìn)入數(shù)據(jù)服務(wù)。
創(chuàng)建API服務(wù)。
在數(shù)據(jù)服務(wù)頁(yè)面內(nèi)，單擊
圖標(biāo)，單擊選擇，進(jìn)入生成API對(duì)話框，選擇向?qū)Ｊ?/b>生成API。說(shuō)明生成API方式有向?qū)Ｊ?/b>和腳本模式兩種，本示例以向?qū)Ｊ?/b>為例。
向?qū)Ｊ缴葾PI可參見(jiàn)通過(guò)向?qū)Ｊ缴葾PI文檔。
腳本模式生成API可參見(jiàn)通過(guò)腳本模式生成API文檔。
步驟二：配置用戶畫(huà)像API
配置詳情。
在向?qū)Ｊ较聞?chuàng)建用戶畫(huà)像API服務(wù)，可通過(guò)以下配置實(shí)現(xiàn)StarRocks數(shù)據(jù)源類型的API數(shù)據(jù)服務(wù)，詳情請(qǐng)參見(jiàn)通過(guò)向?qū)Ｊ缴葾PI。
模塊
配置項(xiàng)
配置內(nèi)容
示例內(nèi)容
選擇表
數(shù)據(jù)源類型
選擇數(shù)據(jù)源類型。
說(shuō)明API數(shù)據(jù)服務(wù)不支持Hive數(shù)據(jù)源，具體以數(shù)據(jù)源類型下拉列表為準(zhǔn)。
本示例以StarRocks數(shù)據(jù)源為例。
數(shù)據(jù)源名稱
選擇已創(chuàng)建的數(shù)據(jù)源。
使用業(yè)務(wù)數(shù)據(jù)源
Doc_StarRocks_Storage_Compute_Tightly_01。數(shù)據(jù)源環(huán)境
生產(chǎn)環(huán)境
開(kāi)發(fā)環(huán)境
選擇生產(chǎn)環(huán)境。
數(shù)據(jù)表名稱
選擇 API 使用到的表。
選擇
ads_user_info_1d_StarRocks表。選擇參數(shù)
返回結(jié)果分頁(yè)
返回結(jié)果分頁(yè)是否開(kāi)啟，將影響API的請(qǐng)求參數(shù)和返回參數(shù)設(shè)置。
在右側(cè)導(dǎo)航欄的服務(wù)資源組中，支持根據(jù)資源組類型設(shè)置單次請(qǐng)求數(shù)據(jù)條數(shù)上限。詳情請(qǐng)參見(jiàn)配置API。
不開(kāi)啟返回結(jié)果分頁(yè)。
設(shè)為請(qǐng)求參數(shù)
將表內(nèi)某字段設(shè)為請(qǐng)求參數(shù)，可多選。
dt分區(qū)字段設(shè)置為請(qǐng)求參數(shù)。設(shè)為返回參數(shù)
將表內(nèi)某字段設(shè)為返回參數(shù)，可多選。
ads_user_info_1d_StarRocks全表所有字段設(shè)為返回參數(shù)。排序字段
排序字段為非必填項(xiàng)。如果您需要對(duì)字段進(jìn)行排序，請(qǐng)首先在選擇參數(shù)的列表中選擇所需字段。
不進(jìn)行排序。
配置服務(wù)資源組
完成向?qū)Ｊ紸PI配置后，單擊頁(yè)面右側(cè)導(dǎo)航欄的服務(wù)資源組，可對(duì)服務(wù)資源進(jìn)行配置，詳細(xì)配置項(xiàng)如下，更多詳情請(qǐng)參見(jiàn)配置API服務(wù)資源組。
模塊
配置項(xiàng)
配置內(nèi)容
資源組類型
方案
獨(dú)享服務(wù)資源組。
獨(dú)享服務(wù)資源組
可選擇Serverless資源組（推薦）或獨(dú)享服務(wù)資源組。
重要如果已購(gòu)買獨(dú)享服務(wù)資源組，直接使用即可。
如果沒(méi)有任何資源組，則推薦購(gòu)買Serverless通用型資源組，詳情可參見(jiàn)新增和使用Serverless資源組。
若新購(gòu)的Serverless資源組在配置服務(wù)資源組時(shí)為灰色，不可選擇，需要對(duì)該資源組的數(shù)據(jù)服務(wù)用途進(jìn)行配額，具體操作，請(qǐng)參見(jiàn)配額管理。
環(huán)境配置
超時(shí)時(shí)間
配置為30000 ms。
單次請(qǐng)求數(shù)據(jù)條數(shù)上限
配置為2000條。
步驟三：測(cè)試發(fā)布API
通過(guò)測(cè)試API來(lái)判斷生成的API服務(wù)返回的參數(shù)是否符合預(yù)期，詳情請(qǐng)參見(jiàn)測(cè)試API。
完成配置后，單擊
保存API，然后單擊
進(jìn)入API測(cè)試頁(yè)面。在API測(cè)試對(duì)話框中，輸入請(qǐng)求參數(shù)的值。
單擊開(kāi)始測(cè)試，即可對(duì)API進(jìn)行測(cè)試。
發(fā)布API，本質(zhì)上是將API發(fā)布至API網(wǎng)關(guān)，從而生成在線調(diào)用地址，以下為發(fā)布至API網(wǎng)關(guān)的操作，詳情請(qǐng)參見(jiàn)發(fā)布API。
在API測(cè)試成功后，在API編輯頁(yè)面，單擊
提交，會(huì)生成一個(gè)新API版本，您可以在右側(cè)單擊版本查看已經(jīng)提交的API版本信息。
單擊發(fā)布即可成功發(fā)布API服務(wù)。
API發(fā)布后可單擊版本管理處的服務(wù)管理或在頁(yè)面上切換至中對(duì)已發(fā)布API進(jìn)行管理。具體詳情可參考管理與維護(hù)API。
后續(xù)步驟
當(dāng)API發(fā)布成功后，即可進(jìn)一步對(duì)API進(jìn)行授權(quán)和調(diào)用等操作，具體詳情請(qǐng)參見(jiàn)授權(quán)API和調(diào)用API文檔。