服務專案是資料服務的基主要組織單元,是進行多使用者隔離和存取控制的主要邊界。後續您需要通過服務專案使用資料服務。本文為您介紹如何建立及管理服務專案。
前提條件
若且唯若網關設定完成後,可建立服務專案,如需配置網關,請參見資料服務設定。
許可權說明
超級管理員和系統管理員支援建立及管理服務專案,包括管理專案成員。
服務專案系統管理員支援管理自己所負責的專案及專案成員。
建立服務專案
在Dataphin首頁的頂部功能表列,選擇服務 > 服務管理。
在左側導覽列單擊專案管理,在專案管理頁面,單擊右上方的+建立服務專案按鈕。
在服務專案設定對話方塊中,配置參數。
參數
描述
服務專案名稱
填寫服務專案的名稱。命名規則如下:
包含中文、字母、數字、底線(_)及短劃線(-)。
以中文或字母開頭。
不能超過32個字元。
描述
填寫對服務專案簡單的描述。不超過128個字元。
API發布管控
API發布到線上使用的過程中,有五種變更情境(新增必填請求參數、刪減請求參數、刪減返回參數、變更請求參數的資料類型以及變更調用類型),會影響API以及關聯的組合API的正常調用。因此,在API已授權給應用或者被組合API引用後,API發布新版本到線上時,會與線上的版本進行對比,如果存在以上變更,您可基於API的使用情境,針對不同專案下的API靈活配置發布管控機制。下面為發布管控的具體管控項,可對這兩種情況選擇阻塞發布或允許發布。
API已授權給應用:預設阻塞發布,支援修改為允許發布。
API已被組合API引用:預設阻塞發布,支援修改為允許發布。
不同發布管控機制的適用範圍說明如下。
當發布管控中API已授權給應用、API已被組合API引用選擇為阻塞發布時,API綁定應用或者被組合API引用時,不允許新版本發布到線上,保證下遊應用和組合API的正常調用。適用於使用範圍廣,影響面大的重要API,如果變更發布到線上會嚴重影響下遊時可以攔截。
當發布管控中API已授權給應用選擇為允許發布,API已被組合API引用選擇為阻塞發布時,API被組合API引用時,不允許新版本發布到線上,保證組合API的正常調用,調用受影響的應用由開發人員線下通知對應的負責人。適用於API變更發布到線上後,能及時通知應用負責人調整應用調用配置的情況,確保應用正常調用API。
說明若API被其他組合API引用又無法通知到組合API的負責人及時修正組合API時,為避免因子API的變更導致組合API不能正常調用的問題,則不允許API的變更發布到線上。
當發布管控中API已授權給應用選擇為阻塞發布,API已被組合API引用選擇為允許發布時,API綁定應用時,不允許新版本發布到線上,保證下遊應用正常調用,調用受影響的組合API由開發人員線下通知群組合API的負責人。適用於僅保證下遊應用能正常調用API。
說明若API被其他組合API引用,則由開發人員告知對應組合API的負責人及時修正組合API,以保證組合API的正常調用。
當發布管控中API已授權給應用、API已被組合API引用選擇為允許發布時,新版本均可發布到線上,調用受影響的組合API和下遊應用,由開發人員通知對應負責人。適用於影響範圍小,下遊使用比較少的API,即使變更發布到線上導致API無法正常調用也不影響業務的API。
發布管控口徑定義變更,4.4版本之前的使用者可根據下圖查看對應的口徑。
單擊提交,完成服務專案的建立。
管理服務專案
您可以在專案管理頁面下進行添加專案成員、建立服務專案分組、編輯服務專案、刪除服務專案等操作。
操作 | 描述 |
編輯 | 支援修改專案的名稱、描述、API發布管控資訊。API發布管控修改會影響新版本API的發布策略。 |
成員管理 | 支援為專案增加或刪除成員並為其設定角色,詳情請參見新增成員並設定角色。 |
分組管理 | 支援為專案設定服務單元、API分組,便於專案管理,詳情請參見建立服務專案分組。 |
刪除 | 需將專案中所依賴的API、服務單元刪除後,才能將專案刪除。 |
後續步驟
如果您需要其RAM使用者協助開發時,可以將Dataphin成員列表中的RAM使用者添加為服務專案的成員並設定角色。具體操作,請參見新增成員並設定角色。