創(chuàng)建API接口
數(shù)據(jù)服務(wù)功能是將數(shù)據(jù)服務(wù)化，通過接口將數(shù)據(jù)庫中的數(shù)據(jù)提供給上層應(yīng)用。該功能僅適用于專業(yè)版。
操作步驟
您可以通過以下方式進(jìn)行數(shù)據(jù)服務(wù)功能設(shè)置：
登錄Quick BI控制臺。
在Quick BI產(chǎn)品首頁，按照下圖指引，新建API。
在新建API的配置基礎(chǔ)信息頁面，輸入API名稱、接口工作空間、接口數(shù)據(jù)集、數(shù)據(jù)返回類型、API描述等參數(shù)并單擊下一步，下圖所示。
在新建API的添加API參數(shù)頁面，設(shè)置請求參數(shù)和返回參數(shù)，并單擊保存或者保存并調(diào)試，如下圖所示。
說明保存可保存當(dāng)前設(shè)置，保存并調(diào)試可跳轉(zhuǎn)至調(diào)試API頁面。
單擊保存并調(diào)試進(jìn)入調(diào)試API頁面，輸入調(diào)試參數(shù)值并選擇返回參數(shù)。
單擊運(yùn)行調(diào)試，在調(diào)試結(jié)果中可查看返回JSON和數(shù)據(jù)預(yù)覽，如下圖所示。
說明通過數(shù)據(jù)服務(wù)功能創(chuàng)建的API接口存在以下調(diào)用權(quán)限限制：調(diào)用API接口的阿里云賬戶，需被授予Quick BI組織管理員及權(quán)限管理員的權(quán)限，且至少登錄過一次Quick BI，才支持調(diào)用API接口。
相關(guān)操作
完成接口創(chuàng)建后，您可以通過數(shù)據(jù)服務(wù)模塊查看已創(chuàng)建API接口的ID、名稱、所屬數(shù)據(jù)集、所屬工作空間等信息，不同頁簽下所顯示的API接口及可進(jìn)行的操作不同。
我的 頁簽下展示了當(dāng)前用戶創(chuàng)建的所有API接口及其相關(guān)信息，同時此頁面支持進(jìn)行以下操作。
查看
點(diǎn)擊API ID旁的
圖標(biāo)，即可于右側(cè)彈窗中查看該API的基本信息、請求參數(shù)與返回參數(shù)。您也可以在該彈窗中對當(dāng)前API進(jìn)行修改、調(diào)試、刪除、轉(zhuǎn)讓。
編輯
點(diǎn)擊操作列
圖標(biāo)，跳轉(zhuǎn)至編輯API頁面，按需修改當(dāng)前API的基礎(chǔ)信息、參數(shù)信息，完成后點(diǎn)擊保存/保存并測試。
調(diào)試
點(diǎn)擊操作列
圖標(biāo)，跳轉(zhuǎn)至調(diào)試API頁面，維護(hù)相關(guān)參數(shù)信息并點(diǎn)擊運(yùn)行調(diào)試。
統(tǒng)計
點(diǎn)擊操作列
圖標(biāo)，跳轉(zhuǎn)至API調(diào)用統(tǒng)計 > 詳情頁面，查看當(dāng)前API接口的各項(xiàng)調(diào)用數(shù)據(jù)。關(guān)于API調(diào)用統(tǒng)計的詳細(xì)說明，請參見API調(diào)用統(tǒng)計。
轉(zhuǎn)讓
點(diǎn)擊操作列
圖標(biāo)，在轉(zhuǎn)讓API > 創(chuàng)建人中選擇需要接收當(dāng)前API創(chuàng)建角色的用戶，點(diǎn)擊確定完成轉(zhuǎn)讓。說明創(chuàng)建人角色默認(rèn)具有當(dāng)前API的調(diào)用及管理權(quán)限。
刪除
點(diǎn)擊操作列
圖標(biāo)，在確認(rèn)彈窗中點(diǎn)擊確定，即可刪除當(dāng)前API。
全部 頁簽下展示了當(dāng)前租戶創(chuàng)建的所有API接口及其相關(guān)信息。
對于當(dāng)前用戶創(chuàng)建的API接口：您可以在此查看您創(chuàng)建的API接口詳情并進(jìn)行管理，具體操作說明同我的所述。
對于非當(dāng)前用戶創(chuàng)建的API接口：僅支持查看API接口詳情，相關(guān)管理操作入口無權(quán)限進(jìn)入。
