阿里云OpenAPI开发者门户

云数据库 MongoDB 版 - OpenAPI 概览2015-12-01
插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.
创建或克隆实例
OpenAPI 名称描述操作
CreateDBInstancehot创建或克隆云数据库MongoDB版副本集实例查看文档去调试
CreateShardingDBInstancehot创建或者克隆MongoDB分片集群实例查看文档去调试
变更实例配置
OpenAPI 名称描述操作
CreateNode为云数据库MongoDB分片集群实例添加Shard节点或Mongos节点查看文档去调试
CreateNodeBatch为云数据库MongoDB分片集群实例批量添加Mongos节点、Shard节点查看文档去调试
ModifyDBInstanceSpec变更云数据库MongoDB单节点实例、副本集实例和Serverless实例(仅中国站支持Serverless实例)的规格或存储空间查看文档去调试
ModifyNodeSpec变更MongoDB分片集群实例中节点的规格和存储空间查看文档去调试
ModifyNodeSpecBatch变更云数据库MongoDB分片集群实例中一个或多个Mongos节点、Shard节点的配置查看文档去调试
ModifyDBInstanceDiskType修改云数据库 MongoDB 版的磁盘类型查看文档去调试
DeleteNode删除MongoDB分片集群实例中的Shard节点或Mongos节点查看文档去调试
实例管理
OpenAPI 名称描述操作
ModifyDBInstanceMaintainTime修改MongoDB实例的可维护时间查看文档去调试
ModifyDBInstanceDescription修改MongoDB实例名称查看文档去调试
ModifyDBInstanceNetExpireTime延长MongoDB实例的经典网络保留时长查看文档去调试
DeleteDBInstance释放MongoDB实例查看文档去调试
UpgradeDBInstanceEngineVersion升级MongoDB实例的数据库版本查看文档去调试
UpgradeDBInstanceKernelVersion升级MongoDB实例的数据库小版本查看文档去调试
SwitchDBInstanceHA切换MongoDB实例中的主备节点查看文档去调试
RestartDBInstance重启MongoDB实例查看文档去调试
DestroyInstance销毁MongoDB实例查看文档去调试
RestartNode重启MongoDB实例的单个节点查看文档去调试
续费管理
OpenAPI 名称描述操作
DescribePrice询价查看文档去调试
DescribeRenewalPrice查询指定MongoDB实例续费一个月的价格查看文档去调试
ModifyInstanceAutoRenewalAttribute设置MongoDB实例的自动续费功能查看文档去调试
TransformInstanceChargeType转换云数据库MongoDB实例的付费类型,将按量付费(后付费)实例转换为包年包月(预付费)实例或者包年包月实例转换为按量付费实例查看文档去调试
TransformToPrePaid将按量付费的MongoDB实例转换为包年包月(预付费)实例查看文档去调试
RenewDBInstance手动续费包年包月的MongoDB实例查看文档去调试
查询实例
OpenAPI 名称描述操作
DescribeReplicaSetRolehot查询MongoDB实例中的角色信息及连接信息查看文档去调试
DescribeKernelReleaseNotes查询MongoDB实例的小版本发布日志查看文档去调试
DescribeAvailableEngineVersion查询MongoDB实例可升级的版本查看文档去调试
DescribeDBInstanceshot查询MongoDB实例列表查看文档去调试
DescribeDBInstanceAttributehot查询云数据库MongoDB实例的信息查看文档去调试
DescribeRoleZoneInfo查询MongoDB实例的各节点的角色和所属的可用区查看文档去调试
DescribeInstanceAutoRenewalAttribute查询MongoDB实例是否为自动付费查看文档去调试
DescribeActiveOperationTaskCount查询MongoDB实例的运维任务数量查看文档去调试
DescribeActiveOperationTaskType查询实例的运维任务类型以及各类型的任务数量查看文档去调试
DescribeDBInstanceSwitchLog查询实例的主备切换日志查看文档去调试
DescribeActiveOperationTasks查询MongoDB实例的计划内运维任务详情查看文档去调试
DescribeDBInstancesOverviewhot查询一个或多个云数据库MongoDB实例的概览信息查看文档去调试
DescribeHistoryTasksStat查看任务中心任务的概览信息查看文档去调试
DescribeHistoryTasks查看任务中心的任务列表查看文档去调试
ModifyTaskInfo任务操作,修改任务中心的任务信息查看文档去调试
ModifyActiveOperationTasks该接口用于修改云数据库MongoDB实例计划内运维任务的切换时间查看文档去调试
资源管理
OpenAPI 名称描述操作
DescribeAvailableResourcehot查询指定可用区的资源信息查看文档去调试
EvaluateResource在新购实例或对实例进行变配之前,评估是否有足够的资源查看文档去调试
DescribeAvailabilityZones查询MongoDB实例支持的可用区列表查看文档去调试
ModifyResourceGroup将MongoDB实例移动到指定资源组查看文档去调试
区域管理
OpenAPI 名称描述操作
DescribeRegionshot查看MongoDB实例支持的所有地域和可用区查看文档去调试
MigrateToOtherZone迁移MongoDB实例到其他可用区查看文档去调试
MigrateAvailableZone迁移MongoDB实例的可用区查看文档去调试
连接管理
OpenAPI 名称描述操作
DescribeShardingNetworkAddress查询MongoDB分片集群实例的连接信息查看文档去调试
ModifyInstanceVpcAuthMode关闭MongoDB实例的专有网络免密访问功能查看文档去调试
ModifyDBInstanceNetworkType切换MongoDB实例的网络类型查看文档去调试
ModifyDBInstanceConnectionString修改MongoDB实例的连接地址和端口查看文档去调试
AllocatePublicNetworkAddress分配公网地址查看文档去调试
ReleasePublicNetworkAddress释放MongoDB实例的公网连接地址查看文档去调试
AllocateNodePrivateNetworkAddress为云数据库MongoDB分片集群实例的Shard节点或ConfigServer节点申请内网连接地址查看文档去调试
ReleaseNodePrivateNetworkAddress释放分片集群实例的Shard节点或ConfigServer节点的内网连接地址查看文档去调试
标签管理
OpenAPI 名称描述操作
ListTagResources查询MongoDB实例和标签的绑定关系查看文档去调试
DescribeTags查询目标地域中所有的标签信息查看文档去调试
TagResources为一个或多个MongoDB实例绑定标签查看文档去调试
UntagResources如果该标签没有绑定到其他实例,则该标签会被删除查看文档去调试
账号管理
OpenAPI 名称描述操作
DescribeAccounts查询MongoDB实例的数据库账号信息查看文档去调试
ResetAccountPassword重置MongoDB实例中数据库账号的密码查看文档去调试
ModifyAccountDescription修改MongoDB实例中root账号的备注信息查看文档去调试
CreateAccount创建MongoDB云盘版分片集群实例的Shard只读账号查看文档去调试
白名单和安全组
OpenAPI 名称描述操作
DescribeSecurityIps查询MongoDB实例的IP白名单查看文档去调试
DescribeSecurityGroupConfiguration查询MongoDB实例绑定的ECS安全组信息查看文档去调试
ModifySecurityIps修改MongoDB实例的IP白名单查看文档去调试
ModifySecurityGroupConfiguration更改MongoDB实例已绑定的ECS安全组查看文档去调试
ModifyGlobalSecurityIPGroup修改云数据库 MongoDB 版的全局IP白名单模板查看文档去调试
DescribeGlobalSecurityIPGroup查询全局IP白名单模板查看文档去调试
ModifyGlobalSecurityIPGroupName修改全局IP白名单模板名称查看文档去调试
DescribeGlobalSecurityIPGroupRelation查询实例与全局IP白名单模板关系映射查看文档去调试
CreateGlobalSecurityIPGroup创建全局IP白名单模板查看文档去调试
ModifyGlobalSecurityIPGroupRelation修改全局白名单模板与MongoDB实例的映射关系查看文档去调试
DeleteGlobalSecurityIPGroup删除全局IP白名单模板查看文档去调试
密钥
OpenAPI 名称描述操作
CheckCloudResourceAuthorized查询KMS密钥是否已授权给MongoDB实例查看文档去调试
DescribeUserEncryptionKeyList查询实例的自定义密钥列表查看文档去调试
DescribeDBInstanceEncryptionKey查询MongoDB实例的某个密钥的详情查看文档去调试
DescribeDBInstanceTDEInfo查询MongoDB实例的透明数据加密TDE(Transparent Data Encryption)是否开启查看文档去调试
ModifyDBInstanceTDE修改MongoDB实例的透明数据加密TDE(Transparent Data Encryption)状态查看文档去调试
DescribeKmsKeys查询云盘加密可选择的Kms密钥查看文档去调试
SSL加密
OpenAPI 名称描述操作
DescribeDBInstanceSSL查询MongoDB实例的SSL设置详情查看文档去调试
ModifyDBInstanceSSL修改MongoDB实例的SSL配置查看文档去调试
审计日志
OpenAPI 名称描述操作
DescribeAuditRecords查询MongoDB实例的审计日志查看文档去调试
DescribeAuditPolicy查询MongoDB实例的审计日志是否开启查看文档去调试
DescribeAuditLogFilter查询MongoDB实例审计日志采集的日志类型查看文档去调试
DescribeMongoDBLogConfig查看MongoDB日志服务的配置查看文档去调试
ModifyAuditLogFilter修改MongoDB实例审计日志的采集类型查看文档去调试
ModifyAuditPolicy设置MongoDB实例的审计日志开关或日志存储时长查看文档去调试
日志管理
OpenAPI 名称描述操作
DescribeSlowLogRecordshot查询MongoDB实例运行出现的慢日志明细查看文档去调试
DescribeErrorLogRecords查询MongoDB实例的错误日志查看文档去调试
DescribeRunningLogRecords查询MongoDB实例的运行日志查看文档去调试
性能监控
OpenAPI 名称描述操作
DescribeDBInstancePerformancehot查询MongoDB实例性能数据查看文档去调试
DescribeDBInstanceMonitor查询MongoDB实例的监控采集粒度查看文档去调试
ModifyDBInstanceMonitor设置MongoDB实例的监控采集粒度查看文档去调试
参数管理
OpenAPI 名称描述操作
DescribeParameterModificationHistory查询MongoDB实例参数的修改记录查看文档去调试
DescribeParameterTemplates查询MongoDB实例默认的参数模板列表查看文档去调试
DescribeParameters查询MongoDB实例的参数配置信息查看文档去调试
ModifyParameters修改MongoDB实例的参数查看文档去调试
备份与恢复
OpenAPI 名称描述操作
CreateBackup创建MongoDB实例备份查看文档去调试
DescribeBackupPolicy查询MongoDB实例的备份策略查看文档去调试
DescribeBackups查询MongoDB实例的备份列表查看文档去调试
DescribeBackupDBs在为MongoDB实例执行单库恢复前,您可以调用本接口查询指定的时间点或备份集内包含的数据库查看文档去调试
DescribeRestoreDBInstanceList查询MongoDB实例7天以内的备份恢复实例列表查看文档去调试
CheckRecoveryCondition检查MongoDB实例是否满足数据恢复的条件查看文档去调试
DescribeClusterBackups查询云数据库 MongoDB 版云盘版分片集群的集群备份集列表查看文档去调试
DescribeClusterRecoverTime查询云数据库 MongoDB 版云盘版分片集群实例的可恢复时间查看文档去调试
DescribeBackupStorage查询MongoDB云盘版副本集或分片集群的备份使用量查看文档去调试
DescribeBackupTasks查询MongoDB云盘版副本集或分片集进行中的备份任务查看文档去调试
DescribeInstanceRecoverTime查询云数据库 MongoDB 版云盘版副本集实例的可恢复时间查看文档去调试
ModifyBackupPolicy修改MongoDB实例的备份策略查看文档去调试
TransferClusterBackup将云数据库 MongoDB 版分片集群实例的备份模式切换为集群备份模式。切换至集群备份模式后,实例将支持高频备份查看文档去调试
其它
OpenAPI 名称描述操作
DescribeActiveOperationTask查询运维任务详情查看文档去调试
DescribeActiveOperationTaskRegion查询运维任务类型和任务数量查看文档去调试
DescribeActiveOperationMaintenanceConfig查询实例的运维任务配置查看文档去调试
CheckServiceLinkedRole查询是否已创建服务关联角色查看文档去调试
ModifyDBInstanceConfig修改实例的属性配置查看文档去调试