OpenAPI集成
除了通過操作可視化控制臺以外,您還可以通過OpenAPI在線調試、阿里云SDK、Terraform、資源編排ROS等方式集成云數據庫 Tair(兼容 Redis)。
OpenAPI介紹
為了能夠讓您快速高效地學習和使用云產品OpenAPI,阿里云提供了OpenAPI網站。它是一款集OpenAPI智能搜索、文檔、在線調試、SDK獲取、CodeSample、調用出錯診斷、調用統計為一體的產品。您可以在OpenAPI門戶中調用阿里云各云產品開放的OpenAPI,查看OpenAPI請求和返回結果。此外,OpenAPI門戶支持自動生成相應的SDK調用示例,幫助您快速使用阿里云產品。更多信息請參見什么是OpenAPI。
版本說明
阿里云OpenAPI通過版本號管控云數據庫 Tair(兼容 Redis)的API列表。
版本號 | 說明 |
推薦使用 |
在線調試
云數據庫 Tair(兼容 Redis)在OpenAPI門戶提供API調試等功能。在調用前,您需要了解云數據庫 Tair(兼容 Redis)提供的版本、接入點說明、集成方式等信息。
調試入口為:https://api.aliyun.com/api/R-kvstore/2015-01-01/CreateInstance
接入點說明
根據實例所在的地域,選擇對應的服務接入點地址,以獲得最低延遲。
例如華北3(張家口)的VPC接入地址為r-kvstore-vpc.cn-zhangjiakou.aliyuncs.com
,更多信息請參見服務接入點。
支持的用戶身份
當您登錄OpenAPI門戶網站后,OpenAPI默認使用您所登錄的賬號進行在線OpenAPI調試。由于阿里云賬號擁有所有API的訪問權限,存在較高風險,因此不建議您使用阿里云賬號在線調試API。強烈建議您創建并使用RAM用戶進行API訪問或日常運維,并根據業務的實際情況按需分配權限,再進行API調用。RAM用戶需具備云數據庫 Tair(兼容 Redis)操作的權限,具體操作請參見使用RAM進行訪問控制。
用戶身份 | 支持情況 |
支持 | |
RAM用戶(推薦) | 支持 |
RAM角色(推薦) | 支持 |
集成方式
云數據庫 Tair(兼容 Redis)提供阿里云SDK、資源編排等多種集成方式,您可以根據業務的實際需要進行選擇。
調用方式 | 支持情況 | 說明 |
阿里云SDK(推薦) 阿里云為您提供了多種編程語言(Java、C#、Go、Python、Swift、TypeScript、PHP、C++等)的SDK。SDK屏蔽了OpenAPI實現細節,統一身份、認證及簽名規則。您只需要集成SDK,通過SDK直接調用OpenAPI。 | 支持 | 云數據庫 Tair(兼容 Redis)SDK支持的語言及依賴安裝方法請參見云數據庫 Tair(兼容 Redis)SDK。 |
阿里云CLI命令行工具可以幫您在命令行Shell中,使用 | 支持 | 您可以在阿里云CLI中輸入 |
Terraform是一種開源工具,用于安全高效地預覽,配置和管理云基礎架構和資源。它與阿里云的資源編排服務的運行機制類似,通過將模板轉化為內部數據后完成OpenAPI調用。 | 支持 | 云數據庫 Tair(兼容 Redis)支持在Terraform中編排、使用的普通資源和數據資源清單,請參見Terraform資源列表(Redis)。 |
資源編排服務ROS(Resource Orchestration Service)是阿里云提供的一項簡化云計算資源管理的服務。開發者和管理員可以編寫模板,在模板中定義所需的阿里云資源(例如:ECS實例、RDS數據庫實例)、資源間的依賴關系等。ROS的編排引擎將根據模板自動完成所有資源的創建和配置,實現自動化部署及運維。 | 支持 | 云數據庫 Tair(兼容 Redis)支持在資源編排服務ROS中調用的普通資源和數據資源清單,請參見資源變配清單(Redis)。 |
若以上方案均無法滿足您的業務需要,可自行封裝請求調用OpenAPI(不推薦),更多信息請參見V3版本請求體&簽名機制。
注意事項
如果調用API后返回錯誤,您需要根據返回的錯誤碼提示檢查傳入的請求參數及其取值是否正確,更多信息請參見錯誤碼中心。
您也可以記錄下調用返回的RequestID或SDK報錯信息,通過阿里云OpenAPI診斷平臺進行自助診斷。