云數據庫 MongoDB 版提供可視化操作控制臺,還提供OpenAPI在線調試、阿里云SDK、CLI等調用方式。為提升您使用云數據庫 MongoDB 版的開發效率,建議您按需選擇合適的操作和集成方式。
OpenAPI介紹
為了能夠讓您快速高效地學習和使用云產品OpenAPI,阿里云為用戶提供OpenAPI網站。它是一款集OpenAPI智能搜索、文檔、在線調試、SDK獲取、CodeSample、調用出錯診斷、調用統計為一體的產品。您可以在OpenAPI門戶中調用阿里云各云產品開放的OpenAPI,查看OpenAPI請求和返回結果。此外,OpenAPI門戶會自動生成相應的SDK調用示例,幫助您快速使用阿里云產品。更多信息,請參見什么是OpenAPI。
版本說明
阿里云OpenAPI通過版本號管控各時期云產品大版本的API。例如云數據庫 MongoDB 版目前支持2015-12-01
版本的API,2015-12-01
代表的是API版本號而非時間概念,所展示的都是最新的API公開數據,并非自2015-12-01
之后就未更新。
API 版本號 | 說明 |
推薦使用 |
在線調試
云數據庫 MongoDB 版在OpenAPI門戶提供API調試等功能。在調用前,您需要了解云數據庫 MongoDB 版提供的版本、接入點、接口風格、調用方式等信息。
調試入口
接入點說明
根據相關資源所在地域,選擇對應的服務接入點地址,以獲得最低延遲。例如華北3(張家口)的云數據庫 MongoDB 版公網接入地址為mongodb.cn-zhangjiakou.aliyuncs.com
,VPC接入地址為mongodb-vpc.cn-zhangjiakou.aliyuncs.com
。
公網接入地址在全球都可以訪問。
VPC接入地址只有在阿里云對應的地域內,且是VPC網絡類型才可訪問。VPC地址的優勢:
高安全性:VPC接入地址只能在VPC內部訪問,提供更高的安全性和隱私性。
更快的響應速度:由于VPC接入地址在VPC內部網絡中運行,其響應速度通常比公網服務更快,且可以避免公網延遲和帶寬限制等問題。
更低的成本:VPC接入地址可以使用內部網絡通信。
更多信息,請參見服務接入點。
支持的調用身份
您的阿里云賬號登錄OpenAPI網站后,OpenAPI默認使用您的阿里云賬號進行在線OpenAPI調試。阿里云賬號擁有所有API的訪問權限,風險很高。強烈建議您創建并使用RAM用戶進行API訪問或日常運維。請根據業務的實際情況按需分配權限后進行接口調用。RAM用戶需具備操作云數據庫 MongoDB 版的權限,詳情請參見使用RAM進行訪問控制。
用戶身份 | 支持情況 |
支持 | |
RAM用戶(推薦) | 支持 |
RAM角色(推薦) | 支持 |
集成方式
云數據庫 MongoDB 版提供SDK、CLI等多種集成方式,您可以根據業務的實際需要進行選擇。
集成方式名稱 | 支持與否 |
阿里云SDK(推薦) | 支持 |
支持 | |
支持 | |
支持 | |
支持 |
阿里云SDK
阿里云為開發者提供了多種編程語言(Java、C#、Go、Python、Node.js/TypeScript、PHP、C++ 等)的SDK。開發者只需要集成SDK,通過SDK暴露的方法直接調用OpenAPI 。SDK統一封裝了簽名邏輯、超時機制、重試機制,并根據文檔返回結構化Response對象,易于開發。更多關于阿里云SDK的介紹,請參見阿里云SDK。
支持在OpenAPI通過阿里云SDK調用云數據庫 MongoDB 版。支持語言及依賴安裝方法請參見云數據庫 MongoDB 版 SDK。
阿里云CLI
阿里云命令行工具可以幫您在使用命令行終端時,使用
aliyun
命令與阿里云服務進行交互,管理云服務資源。有關阿里云CLI的更多詳細信息,請參見什么是阿里云CLI。支持使用阿里云CLI調用MongoDB API。更多信息,請參見使用阿里云CLI調用RPC API。
快速使用阿里云CLI調用云數據庫 MongoDB 版API,請參見CLI集成示例。
Terraform
Terraform是一種開源工具,用于安全高效地預覽,配置和管理云基礎架構和資源。它與阿里云的資源編排服務的運行機制類似,通過將模板轉化為內部數據后完成OpenAPI調用。更多詳情,請參見什么是Terraform。
支持Terraform編排和使用云數據庫 MongoDB 版,支持部分普通資源和數據資源清單,請參見MongoDB。
快速使用Terraform編排云數據庫 MongoDB 版,請參見Terraform集成示例。
資源編排ROS
資源編排服務ROS(Resource Orchestration Service)是阿里云提供的一項簡化云計算資源管理的服務。開發者和管理員可以編寫模板,在模板中定義所需的阿里云資源(例如:ECS實例、RDS數據庫實例)、資源間的依賴關系等。ROS的編排引擎將根據模板自動完成所有資源的創建和配置,實現自動化部署及運維。更多詳情,請參見什么是資源編排服務。
支持使用資源編排服務ROS調用云數據庫 MongoDB 版。編排的部分資源包括普通資源(例如創建實例、克隆實例)和數據資源(例如查詢實例詳情列表、查詢支持創建的實例規格)。
普通資源:
ALIYUN::MONGODB::Instance:創建云數據庫MongoDB版實例
ALIYUN::MONGODB::ServerlessInstance:創建MongoDB Serverless版實例
ALIYUN::MONGODB::ShardingInstance:創建或者克隆MongoDB分片集群實例
數據資源:
DATASOURCE::MONGODB::Instances:查詢MongoDB實例詳情列表
DATASOURCE::MONGODB::InstanceClasses:查詢指定可用區內支持創建的MongoDB實例規格
快速使用資源編排ROS編排云數據庫 MongoDB 版,請參見資源編排集成示例。
自定義封裝
如果以上方案均無法滿足您的業務需要,可自行封裝請求調用OpenAPI(不推薦),詳情請參見V3版本請求體&簽名機制。
注意事項
如果調用API后返回錯誤,您需要根據返回的錯誤碼提示檢查傳入的請求參數及其取值是否正確,更多信息請參見錯誤碼中心。
您也可以記錄下調用返回的RequestID或SDK報錯信息,通過阿里云OpenAPI診斷平臺進行自助診斷。