云数据库 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诊断平台进行自助诊断。