發布API
更新時間 2023-07-18 01:30:37
最近更新時間: 2023-07-18 01:30:37
分享文章
本章節主要介紹發布API。
本文將為您介紹如何將數據服務中的API發布到服務目錄。
操作場景
數據服務是數據對外開放的最后一道防線,為了安全起見,在數據服務中生成的API以及注冊的API,都需要發布到服務目錄中才能對外提供服務。
操作步驟
1.在DataArts Studio控制臺首頁,選擇實例,點擊“進入控制臺”,選擇對應工作空間的“數據服務”模塊,進入數據服務頁面。
詳見下圖: 選擇數據服務

2.在左側導航欄選擇服務版本(例如:專享版),進入總覽頁。
3.進入“數據服務 > 總覽 > 開發API > API管理”頁面,在API服務列表操作列中,選擇“更多 > 發布”。
4.在確認發布界面,您可以點擊“更多”,選擇發布詳情。
詳見下圖: 發布詳情

?專享版默認發布到數據服務專享版集群上,發布成功后API調用者可以通過內網調用該API。您也可以選擇“更多”,將API發布到APIG專享版或ROMA Connect實例上。
- APIG專享版:如果您需要將API發布到APIG專享版上,則您需要提前在API網關服務上創建一個APIG實例。實例創建后,有一個默認API分組,系統為分組自動分配一個內部測試用的調試域名,此調試域名唯一且不可更改,每天最多可以訪問1000次。如果您不希望與其他API共享此規格,可以在APIG控制臺新建一個API分組(詳情請參考“API網關APIG用戶指南> API分組管理> 創建API分組”章節),然后在數據服務發布時選擇對應API分組,獨享每天最多訪問1000次的規格。另外,您還可以為API分組綁定一個或多個獨立域名(詳情請參考“API網關APIG用戶指南>API分組管理> 綁定域名”章節),API調用者通過訪問獨立域名來調用您開放的API,這樣即可不受每天最多訪問1000次的規格限制。
- ROMA Connect實例:如果您需要將API發布到ROMA Connect實例上,則您需要提前在ROMA Connect服務上創建一個ROMA實例,并創建API分組(詳情請參考“應用與數據集成平臺 ROMA Connect用戶指南> 服務集成指導> 開放API> 創建API分組”章節)。API分組創建后,系統為分組自動分配一個內部測試用的子域名,此子域名每天最多可以訪問1000次。為了不受此規格限制,您可以為API分組綁定獨立域名(詳情請參考“應用與數據集成平臺 ROMA Connect用戶指南> 服務集成指導> 開放API> 綁定域名”章節),API調用者通過訪問獨立域名來調用您開放的API。
5.在發布API時,會觸發審核,審核機制如下:
- 當發布人不具備審核人權限時,發布API時需要提交給審核人審核。
- 當發布人具備審核人權限時,可無需審批直接發布API。工作空間管理員角色的用戶默認具備審核人權限。
如果非審核人權限的用戶發布API時,待審核人審核通過后,即可發布完成。
后續操作
發布完成后,您可以進入到“服務目錄”,查看API信息。
也可以對API進行管理,請參見"管理API",或進一步在“運營管理 > 流控策略”頁面設置流量控制等功能,請參見"流量控制"。