集成概覽
本文為您介紹使用云原生數(shù)據(jù)倉庫 AnalyticDB MySQL 版OpenAPI的基本信息及注意事項。
OpenAPI介紹
為了能夠讓您快速高效地學(xué)習(xí)和使用云產(chǎn)品OpenAPI,阿里云提供了OpenAPI網(wǎng)站。它是一款集OpenAPI智能搜索、文檔、在線調(diào)試、SDK獲取、CodeSample、調(diào)用出錯診斷、調(diào)用統(tǒng)計為一體的產(chǎn)品。您可以在OpenAPI門戶中調(diào)用阿里云各云產(chǎn)品開放的OpenAPI,查看OpenAPI請求和返回結(jié)果。此外,OpenAPI門戶會自動生成相應(yīng)的SDK調(diào)用示例,幫助您快速使用阿里云產(chǎn)品。更多信息,請參見什么是OpenAPI。
版本說明
阿里云OpenAPI通過版本號管控不同架構(gòu)的云原生數(shù)據(jù)倉庫 AnalyticDB MySQL 版集群的API,請您根據(jù)自己的集群類型選擇合適版本的API。
版本號 | 說明 |
2019-03-15 | 集群使用該版本號調(diào)用API。 |
2021-12-01 | 企業(yè)版、基礎(chǔ)版及湖倉版集群使用該版本號調(diào)用API。 |
在線調(diào)試
云原生數(shù)據(jù)倉庫 AnalyticDB MySQL 版在OpenAPI門戶提供API調(diào)試等功能。在調(diào)用前,您需要了解云原生數(shù)據(jù)倉庫 AnalyticDB MySQL 版提供的版本、接入點說明、集成方式等信息。
調(diào)試入口
云原生數(shù)據(jù)倉庫 AnalyticDB MySQL 版分為數(shù)倉版、企業(yè)版、基礎(chǔ)版及湖倉版。每個版本API的調(diào)試入口不同,請您根據(jù)自己的版本,選擇合適的API調(diào)試入口。
集群類型 | 調(diào)試入口 |
數(shù)倉版 | |
企業(yè)版、基礎(chǔ)版及湖倉版 |
接入點說明
根據(jù)相關(guān)資源所在地域,選擇對應(yīng)的接入地址,以獲得最低延遲。例如華北3(張家口)云原生數(shù)據(jù)倉庫 AnalyticDB MySQL 版的公網(wǎng)接入地址為adb.cn-zhangjiakou.aliyuncs.com
,VPC接入地址為adb-vpc.cn-zhangjiakou.aliyuncs.com
。
公網(wǎng)接入地址在全球都可訪問。
VPC(Virtual Private Cloud)隔離了虛擬網(wǎng)絡(luò),每個VPC對應(yīng)一個虛擬化網(wǎng)絡(luò)。VPC地址的優(yōu)勢:
高安全性:VPC接入地址只能在VPC內(nèi)部訪問,提供更高的安全性和隱私性。
更快的響應(yīng)速度:由于VPC接入地址在VPC內(nèi)部網(wǎng)絡(luò)中運行,其響應(yīng)速度通常比公網(wǎng)接入地址更快,并且可以避免公網(wǎng)延遲和帶寬限制等問題。
更低的成本:VPC接入地址可以使用內(nèi)部網(wǎng)絡(luò)通信。
數(shù)倉版接入點信息,請參見服務(wù)接入點;企業(yè)版、基礎(chǔ)版及湖倉版接入點信息,請參見各API文檔中的接入地址信息。
支持的用戶身份
當(dāng)您登錄OpenAPI網(wǎng)站后,OpenAPI默認(rèn)使用您所登錄的賬號進(jìn)行在線OpenAPI調(diào)試。由于阿里云賬號擁有所有API的訪問權(quán)限,存在較高風(fēng)險,因此不建議您使用阿里云賬號在線調(diào)試API。強(qiáng)烈建議您創(chuàng)建并使用RAM用戶進(jìn)行API訪問或日常運維。請根據(jù)業(yè)務(wù)的實際情況按需分配權(quán)限后進(jìn)行API調(diào)用。RAM用戶需具備操作云原生數(shù)據(jù)倉庫 AnalyticDB MySQL 版的權(quán)限。具體操作,請參見授權(quán)信息。
用戶身份 | 支持情況 |
支持 | |
RAM用戶(推薦) | 支持 |
RAM角色(推薦) | 支持 |
集成方式
云原生數(shù)據(jù)倉庫 AnalyticDB MySQL 版提供阿里云SDK、自定義封裝等多種集成方式,您可以根據(jù)業(yè)務(wù)的實際需要進(jìn)行選擇。
SDK便于集成,是OpenAPI最好的調(diào)用方式,推薦您選擇使用SDK。
集成方式名稱 | 支持與否 |
阿里云SDK(推薦) | 支持 |
阿里云CLI | 支持 |
資源編排 | 支持 |
Terraform | 支持 |
自定義封裝 | 支持 |
阿里云SDK
阿里云為您提供了多種編程語言(Java、C#、Go、Python、Node.js、TypeScript、PHP、C++等)的SDK。SDK屏蔽了OpenAPI實現(xiàn)細(xì)節(jié),統(tǒng)一身份、認(rèn)證及簽名規(guī)則。您只需要集成SDK,通過SDK直接調(diào)用OpenAPI。關(guān)于更多阿里云SDK的介紹,請參見阿里云SDK。
支持通過阿里云SDK調(diào)用云原生數(shù)據(jù)倉庫 AnalyticDB MySQL 版的OpenAPI。支持的語言及依賴安裝方法,請參見云原生數(shù)據(jù)倉庫AnalyticDB MySQL版SDK。
阿里云CLI
Terraform
Terraform是一種開源工具,用于安全高效地預(yù)覽,配置和管理云基礎(chǔ)架構(gòu)和資源。它與阿里云的資源編排服務(wù)的運行機(jī)制類似,通過將模板轉(zhuǎn)化為內(nèi)部數(shù)據(jù)后完成OpenAPI調(diào)用。更多詳情,請參見Terraform產(chǎn)品介紹。
支持Terraform編排和使用云原生數(shù)據(jù)倉庫 AnalyticDB MySQL 版。
資源編排ROS
資源編排服務(wù)ROS(Resource Orchestration Service)是阿里云提供的一項簡化云計算資源管理的服務(wù)。開發(fā)者和管理員可以編寫模板,在模板中定義所需的阿里云資源(例如:ECS實例、RDS數(shù)據(jù)庫實例)、資源間的依賴關(guān)系等。ROS的編排引擎將根據(jù)模板自動完成所有資源的創(chuàng)建和配置,實現(xiàn)自動化部署及運維。更多詳情,請參見什么是資源編排服務(wù)。
支持資源編排服務(wù)ROS編排調(diào)用云原生數(shù)據(jù)倉庫 AnalyticDB MySQL 版。更多信息,請參見資源編排。
自定義封裝
您可以參考SDK部分的V3簽名文檔自定義封裝請求來訪問阿里云OpenAPI。原生HTTP調(diào)用需要您自己實現(xiàn)簽名算法,并構(gòu)建自定義請求,發(fā)起HTTP調(diào)用。有關(guān)簽名機(jī)制的更多詳細(xì)信息,請參見V3版本請求體&簽名機(jī)制。
注意事項
如果調(diào)用API后返回錯誤,您需要根據(jù)返回的錯誤碼提示檢查傳入的請求參數(shù)及其取值是否正確,更多信息請參見錯誤碼中心。
您也可以記錄下調(diào)用返回的RequestID或SDK報錯信息,通過阿里云OpenAPI診斷平臺進(jìn)行自助診斷。