备案控制台
文档
产品文档
输入文档关键字查找
首页 云数据库 MongoDB 版 开发参考 API参考指南 API概览

API概览

更新时间：
一键部署
产品详情
相关技术圈
我的收藏
本产品（云数据库 MongoDB 版/2015-12-01）的OpenAPI采用RPC签名风格，签名细节参见签名机制说明。我们已经为开发者封装了常见编程语言的SDK，开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入我们的服务钉钉群（11370001915），在专家指导下进行签名对接。
在使用API前，您需要准备好身份账号及访问密钥（AccessKey），才能有效通过客户端工具（SDK、CLI等）访问API。细节请参见获取AccessKey。

创建或克隆实例

API标题API概述
CreateDBInstance创建或克隆副本集实例创建或克隆云数据库MongoDB版副本集实例。
CreateShardingDBInstance创建或克隆分片集群实例创建或者克隆MongoDB分片集群实例。

变更实例配置

API标题API概述
CreateNode新增Shard节点或Mongos节点为云数据库MongoDB分片集群实例添加Shard节点或Mongos节点。
CreateNodeBatch批量创建节点为云数据库MongoDB分片集群实例批量添加Mongos节点、Shard节点。
DeleteNode删除分片集群实例中的节点删除MongoDB分片集群实例中的Shard节点或Mongos节点。
ModifyDBInstanceSpec变更单节点或副本集实例的规格或存储空间变更云数据库MongoDB单节点实例、副本集实例和Serverless实例（仅中国站支持Serverless实例）的规格或存储空间。
ModifyNodeSpec变更分片集群实例中节点的规格和存储空间变更MongoDB分片集群实例中节点的规格和存储空间。
ModifyNodeSpecBatch批量修改节点规格变更云数据库MongoDB分片集群实例中一个或多个Mongos节点、Shard节点的配置。
ModifyDBInstanceDiskType修改实例磁盘类型修改云数据库 MongoDB 版的磁盘类型。

实例管理

API标题API概述
DeleteDBInstance删除数据库实例释放MongoDB实例。
ModifyDBInstanceMaintainTime修改实例的可维护时间修改MongoDB实例的可维护时间。
ModifyDBInstanceDescription修改实例名称修改MongoDB实例名称。
ModifyDBInstanceNetExpireTime延长MongoDB实例的经典网络保留时长延长MongoDB实例的经典网络保留时长。
UpgradeDBInstanceEngineVersion升级实例的数据库版本升级MongoDB实例的数据库版本。
UpgradeDBInstanceKernelVersion升级实例的数据库小版本升级MongoDB实例的数据库小版本。
SwitchDBInstanceHA切换实例中的主备节点切换MongoDB实例中的主备节点。
RestartDBInstance重启MongoDB实例重启MongoDB实例。
DestroyInstance销毁MongoDB实例销毁MongoDB实例。

续费管理

API标题API概述
ModifyInstanceAutoRenewalAttribute开启或者关闭实例的到期前自动续费功能设置MongoDB实例的自动续费功能。
TransformInstanceChargeType转换云数据库MongoDB实例的付费类型转换云数据库MongoDB实例的付费类型，将按量付费（后付费）实例转换为包年包月（预付费）实例或者包年包月实例转换为按量付费实例。
DescribePrice查询费用查询创建MongoDB实例、升级配置或续费操作产生的费用。
DescribeRenewalPrice查询实例续费一个月的价格查询指定MongoDB实例续费一个月的价格。
TransformToPrePaid将按量付费实例转换为包年包月实例将按量付费的MongoDB实例转换为包年包月（预付费）实例。
RenewDBInstance手动续费包年包月的实例手动续费包年包月的MongoDB实例。

查询实例

API标题API概述
DescribeReplicaSetRole查询实例中的角色信息及连接信息查询MongoDB实例中的角色信息及连接信息。
DescribeKernelReleaseNotes查询实例的小版本发布日志查询MongoDB实例的小版本发布日志。
DescribeAvailableEngineVersion查询实例可升级的版本查询MongoDB实例可升级的版本。
DescribeDBInstances查询MongoDB实例列表查询MongoDB实例列表。
DescribeDBInstanceSwitchLog查询实例的主备切换日志信息查询实例的主备切换日志。
DescribeDBInstanceAttribute查询云数据库MongoDB实例的信息查询云数据库MongoDB实例的信息。
DescribeRoleZoneInfo查询实例的各节点的角色和所属的可用区查询MongoDB实例的各节点的角色和所属的可用区。
DescribeInstanceAutoRenewalAttribute查询MongoDB实例是否为自动付费查询MongoDB实例是否为自动付费。
DescribeActiveOperationTaskCount查询MongoDB实例的运维任务数量查询MongoDB实例的运维任务数量。
DescribeActiveOperationTasks查询运维任务列表查询MongoDB实例的运维任务列表。
DescribeActiveOperationTaskType查询运维任务类型和任务数量查询实例的运维任务类型以及各类型的任务数量。
DescribeDBInstancesOverview查询实例的概览信息查询一个或多个云数据库MongoDB实例的概览信息。
DescribeHistoryTasksStat查询任务中心任务状态的概览信息查看任务中心任务的概览信息。
DescribeHistoryTasks查询任务中心的任务信息查看任务中心的任务列表。
ModifyTaskInfo任务中心修改任务信息任务操作，修改任务中心的任务信息。
ModifyActiveOperationTasks修改多个主动运维任务切换时间该接口用于修改云数据库MongoDB实例计划内运维任务的切换时间。

资源管理

API标题API概述
DescribeAvailableResource查询指定可用区的资源信息查询指定可用区的资源信息。
EvaluateResource评估是否有足够的资源在新购实例或对实例进行变配之前，评估是否有足够的资源。
DescribeAvailabilityZones查看实例支持的可用区查询MongoDB实例支持的可用区列表。
ModifyResourceGroup移动到指定资源组将MongoDB实例移动到指定资源组。

区域管理

API标题API概述
DescribeRegions查询可以使用的阿里云地域查看MongoDB实例支持的所有地域和可用区。
MigrateToOtherZone迁移实例到其他可用区迁移MongoDB实例到其他可用区。
MigrateAvailableZone迁移实例的可用区迁移MongoDB实例的可用区。

连接管理

API标题API概述
ModifyInstanceVpcAuthMode关闭实例的专有网络免密访问功能关闭MongoDB实例的专有网络免密访问功能。
ModifyDBInstanceNetworkType切换实例的网络类型切换MongoDB实例的网络类型。
ModifyDBInstanceConnectionString修改实例的连接地址和端口修改MongoDB实例的连接地址。
DescribeShardingNetworkAddress查询MongoDB分片集群实例的连接信息查询MongoDB分片集群实例的连接信息。
AllocatePublicNetworkAddress为实例申请公网连接地址分配公网地址。
ReleasePublicNetworkAddress释放实例公网地址释放MongoDB实例的公网连接地址。
AllocateNodePrivateNetworkAddress为云数据库分片集群实例节点申请内网连接地址为云数据库MongoDB分片集群实例的Shard节点或ConfigServer节点申请内网连接地址。
ReleaseNodePrivateNetworkAddress释放节点或节点内网连接地址释放分片集群实例的Shard节点或ConfigServer节点的内网连接地址。

标签管理

API标题API概述
ListTagResources查询实例和标签的绑定关系查询MongoDB实例和标签的绑定关系。
DescribeTags查询已有标签列表查询目标地域中所有的标签信息。
TagResources为一个或多个MongoDB实例绑定标签为一个或多个MongoDB实例绑定标签。
UntagResources将标签从实例中解绑如果该标签没有绑定到其他实例，则该标签会被删除。

账号管理

API标题API概述
CreateAccount创建实例的数据库账号创建MongoDB实例的数据库账号信息。
ResetAccountPassword重置MongoDB实例中root账号的密码重置MongoDB实例中root账号的密码。
ModifyAccountDescription修改实例中root账号的备注信息修改MongoDB实例中root账号的备注信息。
DescribeAccounts查询实例的数据库账号信息查询MongoDB实例的数据库账号信息。

白名单和安全组

API标题API概述
ModifySecurityIps设置可以访问实例的 IP 白名单地址修改MongoDB实例的IP白名单。
ModifySecurityGroupConfiguration更改MongoDB实例已绑定的ECS安全组更改MongoDB实例已绑定的ECS安全组。
DescribeSecurityIps查询MongoDB实例的IP白名单查询MongoDB实例的IP白名单。
DescribeSecurityGroupConfiguration查询MongoDB实例绑定的ECS安全组信息查询MongoDB实例绑定的ECS安全组信息。
ModifyGlobalSecurityIPGroup修改全局IP白名单模板修改云数据库 MongoDB 版的全局IP白名单模板。
DescribeGlobalSecurityIPGroup查询全局IP白名单模板查询全局IP白名单模板。
ModifyGlobalSecurityIPGroupName修改全局IP白名单模板名称修改全局IP白名单模板名称。
DescribeGlobalSecurityIPGroupRelation查询实例与全局IP白名单模板关系映射查询实例与全局IP白名单模板关系映射。
CreateGlobalSecurityIPGroup创建全局IP白名单模板创建全局IP白名单模板。
ModifyGlobalSecurityIPGroupRelation修改全局白名单模板和实例的映射关系
DeleteGlobalSecurityIPGroup删除全局IP白名单模板删除全局IP白名单模板。

密钥

API标题API概述
ModifyDBInstanceTDE修改MongoDB实例的透明数据加密TDE状态修改MongoDB实例的透明数据加密TDE（Transparent Data Encryption）状态。
CheckCloudResourceAuthorized查询KMS密钥是否已授权给实例查询KMS密钥是否已授权给MongoDB实例。
DescribeUserEncryptionKeyList查询实例的自定义密钥列表查询实例的自定义密钥列表。
DescribeDBInstanceEncryptionKey查询MongoDB实例的某个密钥的详情查询MongoDB实例的某个密钥的详情。
DescribeDBInstanceTDEInfo查询MongoDB实例的透明数据加密TDE是否开启查询MongoDB实例的透明数据加密TDE（Transparent Data Encryption）是否开启。
DescribeKmsKeys查询云盘加密可选择的Kms密钥查询云盘加密可选择的Kms密钥。

SSL加密

API标题API概述
ModifyDBInstanceSSL修改MongoDB实例的SSL链路配置修改MongoDB实例的SSL配置。
DescribeDBInstanceSSL查询MongoDB实例的SSL设置详情查询MongoDB实例的SSL设置详情。

审计日志

API标题API概述
ModifyAuditLogFilter修改实例审计日志的采集类型修改MongoDB实例审计日志的采集类型。
ModifyAuditPolicy设置实例的审计日志开关或日志存储时长设置MongoDB实例的审计日志开关或日志存储时长。
DescribeAuditRecords查询实例的审计日志查询MongoDB实例的审计日志。
DescribeAuditPolicy查询审计日志是否开启查询MongoDB实例的审计日志是否开启。
DescribeAuditLogFilter查询审计日志采集日志类型查询MongoDB实例审计日志采集的日志类型。
DescribeMongoDBLogConfig查看日志服务的配置查看MongoDB日志服务的配置。

日志管理

API标题API概述
DescribeSlowLogRecords查询实例运行出现的慢操作日志明细查询MongoDB实例运行出现的慢日志明细。
DescribeErrorLogRecords查询实例的错误日志查询MongoDB实例的错误日志。
DescribeRunningLogRecords查询实例的运行日志查询MongoDB实例的运行日志。

性能监控

API标题API概述
ModifyDBInstanceMonitor设置MongoDB实例的监控采集粒度设置MongoDB实例的监控采集粒度。
DescribeDBInstancePerformance查询实例性能数据查询MongoDB实例性能数据。
DescribeDBInstanceMonitor查询MongoDB实例的监控采集粒度查询MongoDB实例的监控采集粒度。

参数管理

API标题API概述
ModifyParameters修改MongoDB实例的参数修改MongoDB实例的参数。
DescribeParameterModificationHistory查询实例参数的修改记录查询MongoDB实例参数的修改记录。
DescribeParameterTemplates查询实例默认的参数模板列表查询MongoDB实例默认的参数模板列表。
DescribeParameters查询实例的参数配置信息查询MongoDB实例的参数配置信息。

备份与恢复

API标题API概述
CreateBackup手动备份实例创建MongoDB实例备份。
ModifyBackupPolicy修改实例的备份策略修改MongoDB实例的备份策略。
DescribeBackupPolicy查看集群自动备份策略查询MongoDB实例的备份策略。
DescribeBackups查询实例的备份列表查询MongoDB实例的备份列表。
DescribeBackupDBs查询指定的时间点或备份集内包含的数据库在为MongoDB实例执行单库恢复前，您可以调用本接口查询指定的时间点或备份集内包含的数据库。
CheckRecoveryCondition检查实例是否满足数据恢复条件检查MongoDB实例是否满足数据恢复的条件。
RestoreDBInstance恢复数据至当前实例恢复数据至当前MongoDB实例。
TransferClusterBackup切换至集群备份模式将云数据库 MongoDB 版分片集群实例的备份模式切换为集群备份模式。切换至集群备份模式后，实例将支持高频备份。
DescribeClusterBackups查询集群备份集列表查询云数据库 MongoDB 版云盘版分片集群的集群备份集列表。
DescribeClusterRecoverTime查询分片集群可恢复时间段查询云数据库 MongoDB 版云盘版分片集群实例的可恢复时间。
DescribeBackupStorage查询实例的备份使用量查询MongoDB云盘版副本集或分片集群的备份使用量。
DescribeBackupTasks 查询实例进行中的备份任务查询MongoDB云盘版副本集或分片集进行中的备份任务。
DescribeInstanceRecoverTime查询副本集实例的可恢复时间查询云数据库 MongoDB 版云盘版副本集实例的可恢复时间。
文档推荐
  • 本页导读 （1）
文档反馈