通過創建API數據源能夠實現Dataphin向API請求業務數據或向API請求寫入數據。本文為您介紹如何創建API數據源。
權限說明
僅支持擁有新建數據源權限點的自定義全局角色和超級管理員、數據源管理員、板塊架構師、項目管理員系統角色創建數據源。
操作步驟
在Dataphin首頁,單擊頂部菜單欄管理中心 > 數據源管理。
在數據源頁面,單擊+新建數據源。
在新建數據源對話框的半結構化存儲區域,選擇API。
如果您最近使用過API,也可以在最近使用區域選擇API。同時,您也可以在搜索框中,輸入API的關鍵詞,快速篩選。
在新建API數據源對話框中,配置相關連接數據源參數。
配置數據源的基本信息。
參數
描述
數據源名稱
命名規則如下:
只能包含中文、英文字母大小寫、數字、下劃線(_)或短劃線(-)。
長度不能超過64字符。
數據源編碼
配置數據源編碼后,您可以在Flink_SQL任務中通過
數據源編碼.表名稱
或數據源編碼.schema.表名稱
的格式引用數據源中的表;如果需要根據所處環境自動訪問對應環境的數據源,請通過${數據源編碼}.table
或${數據源編碼}.schema.table
的變量格式訪問。更多信息,請參見Flink_SQL任務開發方式。重要目前僅支持MySQL、Hologres、MaxCompute數據源。
數據源編碼配置成功后不支持修改。
數據源描述
對數據源的簡單描述。不超過128字符。
數據源配置
選擇需要配置的數據源:
如果業務數據源區分生產數據源和開發數據源,則選擇生產+開發數據源。
如果業務數據源不區分生產數據源和開發數據源,則選擇生產數據源。
標簽
您可根據標簽給數據源進行分類打標,如何創建標簽,請參見管理數據源標簽。
配置數據源與Dataphin的連接參數。
說明通常情況下,生產數據源和開發數據源需配置為非同一個數據源,以實現開發數據源與生產數據源的環境隔離,降低開發數據源對生產數據源的影響。但Dataphin也支持配置成同一個數據源,即相同參數值。
參數
描述
URL地址
請填寫API請求的URL地址。
認證方式
請根據API的認證方式進行選擇。
Basic Auth
用戶名:填寫API的用戶名。
密碼:填寫API密碼。
阿里云appKey auth
AppKey:填寫API的AppKey。
AppSecret:填寫API的AppSecret。
None:API無認證。
API Key
Key:填寫API Key認證方式的鍵。
Value:填寫API Key認證方式的值。
添加至:將API Key添加至API請求體參數Parameters、Headers、Body中的其中一個。
Bearer Token:填寫Token令牌信息。該信息將添加至API的headers中進行請求。
單擊確定,完成API數據源的創建。