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