ApsaraDB for MongoDB提供可視化Operations 主控台,還提供OpenAPI線上調試、阿里雲SDK、CLI等調用方式。為提升您使用ApsaraDB for MongoDB的開發效率,建議您按需選擇合適的操作和整合方式。
OpenAPI介紹
為了能夠讓您快速高效地學習和使用雲產品OpenAPI,阿里雲為使用者提供OpenAPI網站。它是一款集OpenAPI智能搜尋、文檔、線上調試、SDK擷取、CodeSample、調用出錯診斷、調用統計為一體的產品。您可以在OpenAPI門戶中調用阿里雲各雲產品開放的OpenAPI,查看OpenAPI請求和返回結果。此外,OpenAPI門戶會自動產生相應的SDK調用樣本,協助您快速使用阿里雲產品。更多資訊,請參見什麼是OpenAPI。
版本說明
阿里雲OpenAPI通過版本號碼管控各時期雲產品大版本的API。例如ApsaraDB for MongoDB目前支援2015-12-01
版本的API,2015-12-01
代表的是API版本號碼而非時間概念,所展示的都是最新的API公開資料,並非自2015-12-01
之後就未更新。
API 版本號碼 | 說明 |
推薦使用 |
線上調試
ApsaraDB for MongoDB在OpenAPI門戶提供API調試等功能。在調用前,您需要瞭解ApsaraDB for MongoDB提供的版本、存取點、介面風格、調用方式等資訊。
調試入口
存取點說明
根據相關資源所在地區,選擇對應的服務存取點地址,以獲得最低延遲。例如華北3(張家口)的ApsaraDB for 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使用者需具備操作ApsaraDB for MongoDB的許可權,詳情請參見使用RAM進行存取控制。
使用者身份 | 支援情況 |
支援 | |
RAM使用者(推薦) | 支援 |
RAM角色(推薦) | 支援 |
整合方式
ApsaraDB for MongoDB提供SDK、CLI等多種整合方式,您可以根據業務的實際需要進行選擇。
整合方式名稱 | 支援與否 |
支援 | |
支援 | |
支援 | |
支援 | |
支援 |
阿里雲SDK
阿里雲為開發人員提供了多種程式設計語言(Java、C#、Go、Python、Node.js/TypeScript、PHP、C++ 等)的SDK。開發人員只需要整合SDK,通過SDK暴露的方法直接調用OpenAPI 。SDK統一封裝了簽名邏輯、逾時機制、重試機制,並根據文檔返回結構化Response對象,易於開發。更多關於阿里雲SDK的介紹,請參見阿里雲SDK。
支援在OpenAPI通過阿里雲SDK調用ApsaraDB for MongoDB。支援語言及依賴安裝方法請參見ApsaraDB for MongoDB SDK。
阿里雲CLI
阿里雲命令列工具可以幫您在使用命令列終端時,使用
aliyun
命令與阿里雲服務進行互動,管理雲端服務資源。有關阿里雲CLI的更多詳細資料,請參見什麼是阿里雲CLI。支援使用阿里雲CLI調用MongoDB API。更多資訊,請參見使用阿里雲CLI調用RPC API。
快速使用阿里雲CLI調用ApsaraDB for MongoDBAPI,請參見CLI整合樣本。
Terraform
Terraform是一種開源工具,用於安全高效地預覽,配置和管理雲基礎架構和資源。它與阿里雲的Resource Orchestration Service服務的運行機制類似,通過將模板轉化為內部資料後完成OpenAPI調用。更多詳情,請參見什麼是Terraform。
快速使用Terraform編排ApsaraDB for MongoDB,請參見Terraform整合樣本。
Resource Orchestration Service
Resource Orchestration Service服務ROS(Resource Orchestration Service)是阿里雲提供的一項簡化雲端運算資源管理的服務。開發人員和管理員可以編寫模板,在模板中定義所需的阿里雲資源(例如:ECS執行個體、RDS資料庫執行個體)、資源間的依賴關係等。ROS的編排引擎將根據模板自動完成所有資源的建立和配置,實現自動化部署及營運。更多詳情,請參見什麼是Resource Orchestration Service服務。
支援使用Resource Orchestration Service服務ROS調用ApsaraDB for MongoDB。編排的部分資源套件括普通資源(例如建立執行個體、複製執行個體)和資料資源(例如查詢執行個體詳情列表、查詢支援建立的執行個體規格)。
普通資源:
ALIYUN::MONGODB::Instance:建立ApsaraDB for MongoDB執行個體
ALIYUN::MONGODB::ServerlessInstance:建立MongoDB Serverless版執行個體
ALIYUN::MONGODB::ShardingInstance:建立或者複製MongoDB分區叢集執行個體
資料資源:
DATASOURCE::MONGODB::Instances:查詢MongoDB執行個體詳情列表
DATASOURCE::MONGODB::InstanceClasses:查詢指定可用性區域內支援建立的MongoDB執行個體規格
快速使用Resource Orchestration Service編排ApsaraDB for MongoDB,請參見Resource Orchestration Service整合樣本。
自訂封裝
如果以上方案均無法滿足您的業務需要,可自行封裝請求調用OpenAPI(不推薦),詳情請參見V3版本請求體&簽名機制。
注意事項
如果調用API後返回錯誤,您需要根據返回的錯誤碼提示檢查傳入的請求參數及其取值是否正確,更多資訊請參見錯誤碼中心。
您也可以記錄下調用返回的RequestID或SDK報錯資訊,通過阿里雲OpenAPI診斷平台進行自助診斷。