調用API即應用調用生產環境中的API。在為企業建立API生態場景中,您需要調用API進行二次開發或開放API給合作伙伴等,幫助企業實現數據的資產化和價值化。本文為您介紹如何調用API。
前提條件
步驟一:查詢并申請API
在Dataphin首頁,在頂部菜單欄選擇服務 > 市場。
單擊左側導航欄的API服務,在API服務頁面的API列表中,單擊目標文檔說明列下的API文檔,進入API文檔頁面。
在API文檔頁面,查看基本信息、排序設置(僅服務單元API-向導模式支持)、業務請求參數列表、公共請求參數列表、返回參數列表及JSON返回示例,是否符合您的業務場景。
確認當前API符合您業務場景的后,單擊申請狀態列下的立即申請。
在API權限申請頁面,申請API的權限。具體操作,請參見申請API權限。
說明需申請該API的所屬應用權限才能使用該API。
步驟二:調試API
完成API權限申請后,您可以在已授權API服務頁面查看到該API。隨后,您可以進行調試該API是否可以正常使用。您可以根據如下路徑進入API調試頁面。
單擊頂部菜單欄調用 > 選擇服務項目 > 單擊左側導航欄已授權API服務 > 單擊目標API的圖標。
在API調試頁面,配置調試輸入值。調試參數配置與測試API是否一致,詳情請參見步驟一:測試API。
步驟三:下載文檔
您可以下載API文檔分享給其他開發人員,提高使用靈活性。支持下載Word格式的文檔,便于修改。
在Dataphin首頁,單擊頂部菜單欄的服務 > 市場。
單擊左側導航欄的API服務,單擊目標API文檔說明列下的API文檔。
在API文檔頁面,單擊右上角的下載API文檔,下載單個API文檔;您也可以在API服務頁面,選擇多個API,單擊底部的下載API文檔,批量下載API文檔。
下載的API文檔中會根據該API生成具體的調用示例,方便您使用;您也可以根據API調用模板配置調用示例。
支持將API文檔下載至本地,格式為Word。
API文檔包括文檔目錄、文檔版本、API調用示例、接口列表(按接口維度,每個接口內容包括基本信息、排序設置(僅服務單元API-向導模式支持)、業務請求參數列表、公共請求參數列表、返回參數列表、JSON返回示例、該API調用的具體示例)。
API調用模板
單擊頂部菜單欄的管理,再單擊左側導航欄的調用示例。
在API調用示例頁面,查看API調用示例的模板。
您也可以單擊默認調用示例下載,下載API調用示例。
如果需要通過Python方式調用API,則單擊python調用示例下載,下載Python示例文件壓縮包。
如果需要通過Java SDK方式調用API,則單擊Java SDK下載,下載Java SDK代碼包。
根據調用示例說明,進行調用API。
API返回條數
完成調用API后,即可查詢數據。對于不同的服務類型和數據源支持查詢條數如下表所示。
數據源類型 | 單次最大返回條數 | 查詢總條數限制 | 是否支持分頁查詢 |
單物理表服務單元 | |||
MySQL | 10000 | 無上限 | 支持 |
AnalyticDB for MySQL2.0 | 支持 | ||
ElasticSearch | 支持 | ||
Microsoft SQL Server | 不支持 | ||
PostgreSQL | 支持 | ||
AnalyticDB for MySQL3.0 | 支持 | ||
AnalyticDB for PostgreSQL | 支持 | ||
Hologres | 支持 | ||
Hbase(0.9.4/1.1.x/1.2.1/2.x) | 10000 | 10000 | 支持 |
Oracle | 支持 | ||
MongoDB | 支持 | ||
多物理表服務單元 | |||
MySQL | 10000 | 無上限 | 支持 |
AnalyticDB for MySQL2.0 | 支持 | ||
ElasticSearch | 支持 | ||
Microsoft SQL Server | 不支持 | ||
PostgreSQL | 支持 | ||
AnalyticDB for MySQL3.0 | 支持 | ||
AnalyticDB for PostgreSQL | 支持 | ||
Hologres | 支持 | ||
Hbase(0.9.4/1.1.x/1.2.1/2.x) | 10000 | 10000 | 支持 |
Oracle | 支持 | ||
MongoDB | 支持 | ||
直連數據源API | |||
Impala | 10000 | 無上限 | 支持 |
Oracle | 支持 | ||
MySQL | 支持 | ||
PostgreSQL | 支持 | ||
Microsoft SQL Server | 支持 | ||
Hologres | 支持 | ||
Lindorm | 支持 | ||
ClickHouse | 支持 | ||
StarRocks | 支持 | ||
TDengine | 不支持 | ||
SAP HANA | 不支持 | ||
SelectDB | 支持 | ||
Hbase(0.9.4/1.1.x/1.2.1/2.x) | 1 | 無上限 | 不支持 |
ElasticSearch | 10000 | 10000 | 支持 |
邏輯表API | |||
不涉及 | 10000 | 10000 | 支持 |
Dataphin數據源 | |||
Dataphin數據源 | 10000 | 無上限 | 支持 |
在通過SDK調用API時,如需查詢第9000~10000條數據,則公共請求參數PageStart配置為9000,PageSize配置為1000。