您需要申請API許可權後,才能調用API。本文為您介紹如何申請和交還API許可權。
前提條件
已購買資料服務增值服務並且當前租戶已開通資料服務模組。如需開通,請參見租戶管理。
許可權說明
僅應用負責人支援回收API許可權。
申請API許可權
在Dataphin首頁的頂部功能表列,選擇管理中心 > 許可權管理。
在左側導覽列選擇我的許可權 > 資料服務許可權,再單擊頂部功能表列的API許可權,在API許可權頁簽,單擊右上方的+申請API許可權按鈕。
在API許可權申請頁面,配置參數。
參數
描述
API權限物件
帳號類型
選擇API許可權申請的帳號類型,支援選擇應用、個人帳號。系統預設選中應用。
應用:當API為Create、Update、Delete操作類型時,僅可授權應用。
個人帳號:當帳號類型為個人帳號,API選擇開發環境且為Basic模式,訪問的資料環境為生產資料環境,請謹慎操作;若API選擇開發環境且為Dev-Prod模式,訪問的資料環境為開發資料環境。
服務專案
選擇API許可權申請的服務專案,支援多選。
API
根據服務專案、API分組選擇API,您可以根據API名稱的關鍵字進行模糊搜尋,也可以批量搜尋並添加,或單擊
表徵圖,根據API分組進行精確篩選。批量搜尋並添加:單擊批量搜尋並添加按鈕,在批量搜尋對話方塊中,輸入需添加的API名稱,支援按照API服務專案.API名稱進行精確搜尋,多個API名稱之間用半形分號(;)、半形逗號(,)或分行符號(\n)分隔,支援添加不超過50個API。
說明若為個人帳號申請API許可權,需選擇當前操作人已加入的服務專案,避免許可權無法申請。
API運行環境
當帳號類型為應用時需配置。選擇API的運行環境,支援開發環境和生產環境,可多選。
說明API的運行根據所選的運行環境進行運行。當API運行環境選擇開發環境時,API基於提交至開發環境的配置運行;當API運行環境選擇生產環境時,API基於發布至生產環境的配置運行。
應用
當帳號類型選擇應用時需配置。根據應用分組選擇應用,支援選擇當前操作人已加入的應用。您可以根據應用程式名稱的關鍵字進行模糊搜尋,也可以批量搜尋並添加,或單擊
表徵圖,根據應用分組進行精確篩選。批量搜尋並添加:單擊批量搜尋並添加按鈕,在批量搜尋對話方塊中,輸入需添加的應用程式名稱,支援按照應用分組.應用程式名稱進行精確搜尋,多個應用程式名稱之間用半形分號(;)、半形逗號(,)或分行符號(\n)分隔,支援添加不超過50個應用。
申請範圍
當帳號類型選擇應用時需配置。可選欄位將根據API運行環境選擇生產環境或開發環境下需授權的欄位。若API關聯了行級許可權,系統會以行級許可權生效中進行標識,您可以單擊查看行級許可權按鈕,在查看行級許可權面板中,切換查看對應環境的行級許可權資訊。
說明當API選擇開發環境且為Basic模式,訪問的資料環境為生產資料環境,請謹慎操作。
當API運行環境為生產環境時,可選擇當前API線上版本的返回參數;當API運行環境為開發環境時,可選擇當前API最新版本開發環境下的返回參數。
當應用申請代理模式許可權調用API時,系統會根據被代理使用者的行級許可權返回資料範圍;若應用沒有代理模式許可權,則根據應用的行級許可權返回資料。
當API為Create、Update、Delete操作類型時,根據API的運行環境訪問資料,無需選擇欄位。
許可權配置
權限類別型
系統預設選中使用許可權,不支援修改;當帳號類型選擇應用時,支援選擇代理許可權。
使用許可權:當API為Create、Update、Delete操作類型時,僅支援申請使用許可權。
代理許可權:當API開啟了行級許可權且配置的DelegationUid參數非空(即在資料服務 > 調用 > 已授權API服務的調用頁面的公用參數列表地區配置行級許可權參數值)時生效。在調用API時,需申請代理模式許可權,應用才能代理使用者調用關聯了行級許可權的API,更多API調用的直連模式和代理模式說明,請參見API調用/測試直連模式和代理模式說明。
有效期間
系統支援選擇30天、90天、180天和長期,您也可以選中自訂後,選擇到期日。
申請原因
填寫申請原因,便於審批者查看審批原因。不超過128個字元。
單擊提交,完成API許可權申請。
交還API許可權
在API許可權頁簽,單擊目標API操作列下的交還。
在是否進行交還該許可權對話方塊中,單擊確定,完成API許可權的交還。