調用API即應用根據運行環境調用當前環境中的API，特殊的，Basic模式下即使運行環境是開發環境，讀取的仍然為生產環境的資料。在為企業建立API生態情境中，您需要調用API進行二次開發或開放API給夥伴等，協助企業實現資料的資產化和價值化。本文為您介紹如何調用API。
前提條件
API文檔入口說明
從市場進入API文檔：單擊頂部功能表列的服務 > API市場，單擊左側列表的API頁簽，再單擊目標API文檔說明列下的API文檔，進入API文檔頁面。該方式進入生產環境下的API文檔，無論是否擁有許可權，均支援查看並下載API文檔。
從應用管理進入API文檔：僅API已授權應用且使用者有應用的許可權支援進入。單擊頂部功能表列服務 > 應用管理，在左側導覽列選擇服務管理 > 已授權API服務 > 單擊目標API操作列下的查看，進入API文檔頁面。該方式進入開發環境下的API文檔，支援切換環境且可以下載API文檔。
API文檔及調試頁面頂部操作
切換API：您可在頁面左上方切換查看API，根據API的名稱或ID模糊搜尋API，支援搜尋目前使用者已加入服務專案下發行的API。系統將為您推薦最近9條API。
切換API運行環境：
API文檔：僅從應用管理 > 已授權API服務頁面進入的API文檔，支援選擇有許可權環境（開發環境、生產環境）查看API文檔。當運行環境為開發環境時，公用請求參數列表支援apiVersion參數。
調試API：支援選擇有許可權環境（開發環境、生產環境）進行API調試。當運行環境為開發環境，則使用開發資料來源進行調試；當運行環境為生產環境，則使用生產資料來源進行調試。
說明當運行環境為開發環境，組合API調用的子API基於Dev-Prod模式提交的API配置，使用開發環境資料來源進行調試；基於Basic模式提交的API配置，使用生產環境資料來源進行調試。
當運行環境為生產環境，組合API調用的子API基於Dev-Prod模式或Basic模式提交的API配置，使用生產環境資料來源進行調試。
切換API版本：當運行環境為開發環境，調試API時，支援在頁面右上方切換API版本。僅可選擇已提交的版本（包括發行版本）。
步驟一：查詢並申請API
需申請該API的所屬應用許可權才能使用該API。
在Dataphin首頁的頂部功能表列，選擇服務 > API市場。
單擊API頁簽，再單擊目標API文檔說明列下的API文檔，進入API文檔頁面。該方式進入生產環境下的API文檔。根據API是否發布路徑有所差異，詳情請參見API文檔入口說明。
在API文檔頁面，查看API的基本資料、排序設定（僅服務單元API-嚮導模式支援）、業務請求參數列表、公用請求參數列表、關聯線級許可權列表、返回參數列表及JSON返回樣本，是否符合您的業務情境。
說明當API類型為直連資料來源API、服務單元API或組合API且關聯線級許可權開啟時可查看關聯線級許可權列表資訊。
當調用模式為非同步呼叫時，不支援API資料緩衝，可通過遊標的方式增量擷取資料，因此非同步呼叫無需配置緩衝和結果分頁等配置，公用請求參數也不展示PageSize、PageStart資訊。
確認當前API符合您業務情境的後，在API服務頁面單擊申請狀態列下的立即申請，跳轉至管理中心 > 許可權管理 > 我的許可權 > 資料服務許可權頁面申請API的許可權，詳情請參見申請API許可權。
步驟二：調試API
完成API許可權申請後，您可以調試該API是否可以正常使用。
調試API時，輸入參數字元長度不超過1000個；若直接調用API，則無字元長度限制。
步驟三：下載文檔
您可以下載API文檔分享給其他開發人員，提高使用靈活性。支援下載Word格式的文檔，便於修改；也可以下載為OpenAPI規範的YAML文檔，用於阿里雲百鍊大模型的外掛程式註冊。
下載OpenAPI YAML檔案
在Dataphin首頁，單擊頂部功能表列的服務 > API市場。
單擊左側列表的API頁簽，選中目標API單擊文檔說明列下的API文檔。
在API文檔頁面，單擊右上方的下載OpenAPI YAML檔案。
在下載OpenAPI YAML檔案的對話方塊中，配置參數。
參數
描述
格式
支援阿里雲百鍊大模型平台、OpenAPI規範2種格式下載檔案。
operationID
介面操作ID，用於介面操作的唯一標識。僅支援輸入英文、底線（_），不超過200個字元。
summary
介面描述。支援輸入不超過200個字元。
代碼預覽
設定完成後，即可即時預覽代碼（JSON格式）。代碼中各參數釋義請參見OpenAPI 規範。
openapi: 3.0.1 info: title: sq_test_mysql description: "" version: V1.4 servers: - url: http://528fdcdcc62d4f4eb8f10ad99cdda9f3-cn-shanghai.alicloudapi.com paths: /list/10172: post: summary: "" operationId: "" parameters: - name: appKey in: query description: 訪問API所綁定的應用Key required: true schema: type: string example: "2000001" - name: env in: query description: API所在的環境 required: true schema: type: string example: "prod:生產環境, pre:預發環境" requestBody: content: application/json: schema: required: - returnFields type: object properties: useModelCache: type: boolean description: "是否開啟SQL翻譯緩衝, 有利於查詢效能提升" default: false pageStart: type: integer description: 分頁查詢的第幾條開始 format: int32 pageSize: type: integer description: 分頁查詢返回條數 format: int32 returnFields: type: array items: type: string example: "[id, name, sexo]" conditions: required: - sex type: object properties: namee: type: string example: null sex: type: string example: null idd: type: string example: null description: 入參條件 useResultCache: type: boolean description: "是否開啟API查詢結果的緩衝, 有利於查詢效能提升" default: false orderBys: type: array description: 排序欄位 items: type: object properties: field: type: string description: 排序類型，枚舉值(注意大寫)，只有ASC或者DESC order: type: string description: 排序類型，枚舉值(注意大寫)，只有ASC或者DESC example: ASC或者DESC required: true配置完成後，單擊下載，將檔案下載至本地。
下載API文檔
在Dataphin首頁，單擊頂部功能表列的服務 > API市場。
單擊左側列表的API頁簽，單擊目標API文檔說明列下的API文檔。
在API文檔頁面，單擊右上方的下載API文檔，下載單個API文檔；您也可以在API服務頁面，選中多個API，單擊底部的下載API文檔，批量下載API文檔。
說明下載的API文檔中會根據該API產生具體的調用樣本，方便您使用；您也可以根據API調用模板配置調用樣本。
支援將API文檔下載至本地，格式為Word。
API文檔包括文檔目錄、文檔版本、API調用樣本、介面列表（按介面維度，每個介面內容包括基本資料、排序設定（僅服務單元API-嚮導模式支援）、業務請求參數列表、公用請求參數列表、關聯線級許可權列表（僅直連資料來源API、服務單元API或組合API且關聯線級許可權開啟時支援）、返回參數列表、JSON返回樣本以及該API調用的具體樣本）。
當網路設定的API Gateway為阿里雲API Gateway，公網次層網域/內網VPC網域名稱開啟且所有使用者可見時，下載的API文檔可查看正確的Host資訊；若為內建網關，僅是否展示網域名稱為是時，可查看正確的Host資訊。
API調用模板
僅超級管理員支援管理SDK及調用樣本、編輯調用說明。
在資料服務頁面，單擊頂部功能表列應用管理，再單擊左側導覽列的調用說明，進入調用說明頁面。
在調用說明頁面，單擊API調用說明頁簽，進入API調用說明頁面。
在API調用說明頁面，查看API調用樣本的模板，並可執行如下操作。
預設調用樣本下載：您可以單擊預設調用樣本下載，下載API調用樣本，包括同步調用和非同步呼叫。
python調用樣本下載：如果需要通過Python方式調用API，則單擊python調用樣本下載，下載Python樣本檔案壓縮包。
Java SDK下載：如果需要通過Java SDK方式調用API，則單擊Java SDK下載，下載Java SDK程式碼封裝。
管理SDK及調用樣本：單擊管理SDK及調用樣本按鈕，進入管理SDK及調用樣本頁面，您可以統一管理API調用樣本，支援新增調用樣本或對調用樣本進行排序。
新增：單擊底部的新增按鈕，添加調用樣本。
名稱：輸入調用樣本的名稱，將在API調用說明頁面展示。名稱唯一，建議輸入不超過10個字元，最長不超過50個字元。
說明：填寫調用樣本的簡單描述，便於相關業務人員瞭解用途，最長不超過100個字元。
上傳檔案：單擊上傳按鈕，從本地選擇檔案上傳至Dataphin。支援上傳的檔案格式為zip、rar、doc、docx、PDF、jpg且檔案大小不超過200M。
支援將檔案下載至本地。
是否展示：影響在API調用說明頁面是否可見該調用樣本。儲存後，預設開啟，支援關閉該調用樣本。
儲存：支援儲存修改或新增的調用樣本。
編輯/刪除：支援修改或刪除自訂添加的調用樣本配置資訊。
排序：單擊排序，拖動調用樣本進行排序，單擊右上方的完成按鈕，完成排序。此處排序次序將影響API調用說明頁面的預設展示順序。
說明支援建立不超過10個API調用樣本（包含系統預設提供的調用樣本）。
系統預設提供的調用樣本不支援編輯、刪除，支援選擇是否展示該調用樣本。
編輯調用說明：支援根據業務情境修改API調用說明。
根據調用樣本說明，進行調用API。