Dataphin：建立API資料來源

許可權說明

僅支援擁有建立資料來源許可權點的自訂全域角色和超級管理員、資料來源管理員、板塊架構師、專案系統管理員系統角色建立資料來源。

操作步驟

1. 在Dataphin首頁，單擊頂部功能表列管理中心 > 資料來源管理。

2. 在資料來源頁面，單擊+建立資料來源。

3. 在建立資料來源頁面的半結構化儲存地區，選擇API。

   如果您最近使用過API，也可以在最近使用地區選取項目API。同時，您也可以在搜尋方塊中，輸入API的關鍵詞，快速搜尋。

4. 在建立API資料來源頁面中，配置相關串連資料來源參數。

   1. 配置資料來源的基本資料。

      參數	描述
      資料來源名稱	命名規則如下： 只能包含中文、英文字母大小寫、數字、底線（_）或短劃線（-）。 長度不能超過64字元。
      資料來源編碼	配置資料來源編碼後，您可以在Flink_SQL任務中通過資料來源編碼.表名稱或資料來源編碼.schema.表名稱的格式引用資料來源中的表；如果需要根據所處環境自動訪問對應環境的資料來源，請通過${資料來源編碼}.table或${資料來源編碼}.schema.table的變數格式訪問。更多資訊，請參見Dataphin資料來源表開發方式。 重要 資料來源編碼配置成功後不支援修改。 資料來源編碼配置成功後，才能在資產清單的對象詳情頁面進行資料預覽。 Flink SQL中，目前僅支援MySQL、Hologres、MaxCompute、Oracle、StarRocks、Hive、SelectDB資料來源。
      資料來源描述	對資料來源的簡單描述。不超過128字元。
      資料來源配置	選擇需要配置的資料來源： 如果業務資料來源區分生產資料來源和開發資料來源，則選擇生產+開發資料來源。 如果業務資料來源不區分生產資料來源和開發資料來源，則選擇生產資料來源。
      標籤	您可根據標籤給資料來源進行分類打標，如何建立標籤，請參見管理資料來源標籤。

   2. 配置資料來源與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令牌資訊。該資訊將以Authorization: Bearer <token>的形式添加至API的Headers中進行請求。 OAuth2.0：填寫Token首碼、Access Token並配置下方的Access Token擷取配置。 Token首碼（非必填）：填寫Token首碼，預設為Bearer，支援為空白。 Access Token：填寫Access Token擷取配置的返回結果中的Access Token的JSON路徑，支援多級，例如data.access_token。
      Access Token擷取配置	說明 僅當認證方式選擇OAuth2.0時，支援配置此模組參數。 請求方式：可選擇POST或GET，預設為GET。 Token URL：輸入Token的請求地址，格式為https://example.com/oauth/token。 用戶端ID：輸入用戶端的ID。 用戶端密鑰：輸入用戶端的密鑰。 用戶端認證：可選擇在要求標頭中發送基本認證資訊或在請求體中發送用戶端憑證，預設為在要求標頭中發送基本認證資訊。 在要求標頭中發送基本認證資訊：在HTTP請求中直接通過Authorization頭欄位發送基本認證資訊。基本認證的基本格式為Authorization: Basic <credentials>，其中<credentials>是經過Base64編碼的使用者名稱和密碼。 在請求體中發送用戶端憑證：將用戶端認證資訊發送至請求體中，kv形式為client_id、client_secret。
      進階配置	說明 僅當認證方式選擇OAuth2.0時，支援配置此模組參數。 請求參數：可填寫多個請求Token需要的額外參數，預設為空白。當此處填寫的參數與上方認證自動添加的參數衝突時，以此處填寫的參數為準。 參數名稱：僅支援英文字母大小寫、數字、底線（_）和短劃線（-），不超過256個字元。 添加到：可選Parameter、Header、Body，預設為Parameter。僅當請求方式為POST時，才可選擇Body。 串連測試：單擊串連測試後，系統自動對Token URL、用戶端ID、用戶端密鑰、用戶端認證進行校正，串連測試完成後，可單擊展開查詢結果，查看格式化後的JSON。

   3. 進階設定

      串連重試次數：當串連API失敗時，將自動重試串連，直到達到設定的重試次數。若達到設定的重試次數仍未串連成功，則判定為串連失敗。

5. 單擊確定，完成API資料來源的建立。