文档中心

文档数据库 MongoDB 版

API 参考

API 列表

本文汇总了文档数据库 MongoDB 版提供的 API 接口。

说明

单个地域下，文档数据库 MongoDB 版的 API 流控限制为 20 次/秒，即单个火山引擎账号每秒钟调用单个 API 接口的次数不可超过 20。若超过该限制，会导致 API 请求执行失败，并提示 AccountFlowLimitExceeded 报错。

地域和可用区

API	描述
DescribeRegions	调用 DescribeRegions 接口查询文档数据库 MongoDB 版可用的地域资源列表。
DescribeAvailabilityZones	调用 DescribeAvailabilityZones 接口查询文档数据库 MongoDB 版在指定地域下的可用区资源列表。

实例管理

API	描述
CreateDBInstance	调用 CreateDBInstance 接口创建 MongoDB 实例。
DescribeNodeSpecs	调用 DescribeNodeSpecs 接口查询 MongoDB 支持的节点规格列表。
DescribeDBInstances	调用 DescribeDBInstances 接口查询 MongoDB 实例的基本信息。
DescribeDBInstanceDetail	调用 DescribeDBInstanceDetail 接口查询目标 MongoDB 实例的详细信息。
ModifyDBInstanceSpec	调用 ModifyDBInstanceSpec 接口修改目标 MongoDB 实例的配置（例如节点规格或存储空间）。
ModifyDBInstanceName	调用 ModifyDBInstanceName 接口修改目标 MongoDB 实例的实例名称。
RestartDBInstance	调用 RestartDBInstance 接口重启目标 MongoDB 实例。
SwitchDBMaster	调用 SwitchDBMaster 接口手动切换目标 MongoDB 实例的主从节点。
DeleteDBInstance	调用 DeleteDBInstance 接口删除目标 MongoDB 实例。

标签管理

API	描述
AddTagsToResource	调用 AddTagsToResource 接口为目标 MongoDB 实例绑定标签。
RemoveTagsFromResource	调用 RemoveTagsFromResource 接口为目标 MongoDB 实例解绑标签。

计费管理

API	描述
ModifyDBInstanceChargeType	调用 ModifyDBInstanceChargeType 接口修改目标 MongoDB 实例的计费类型。

账号管理

API	描述
CreateDBAccount	调用 CreateDBAccount 接口为目标 MongoDB 实例创建账号。
DescribeDBAccounts	调用 DescribeDBAccounts 接口查询目标 MongoDB 实例下的账号列表。
UpdateDBAccountPrivilege	调用 UpdateDBAccountPrivilege 接口修改目标 MongoDB 实例中指定账号的权限或账号描述。
ResetDBAccount	调用 ResetDBAccount 接口修改目标 MongoDB 实例中指定账号的密码或将 root 账号的权限重置为出初始状态。
DeleteDBAccount	调用 DeleteDBAccount 接口删除目标 MongoDB 实例中的指定账号。

连接管理

API	描述
CreateDBEndpoint	调用 CreateDBEndpoint 接口为目标 MongoDB 实例创建连接地址。
DescribeDBEndpoint	调用 DescribeDBEndpoint 接口查询目标 MongoDB 实例下的连接地址信息。
DeleteDBEndpoint	调用 DeleteDBEndpoint 接口删除目标 MongoDB 实例中指定的连接地址。
ModifyDBEndpointPort	调用 ModifyDBEndpointPort 接口修改目标 MongoDB 实例对应连接地址的端口号。
ModifyDBEndpointPrivateDNSVisibility	调用 ModifyDBEndpointPrivateDNSVisibility 接口为目标 MongoDB 实例开启或关闭公网解析功能。

备份与恢复

API	描述
CreateBackup	调用 CreateBackup 接口为目标 MongoDB 实例手动创建备份。
DescribeDBInstanceBackupPolicy	调用 DescribeDBInstanceBackupPolicy 接口查询目标 MongoDB 实例的自动备份策略。
ModifyDBInstanceBackupPolicy	调用 ModifyDBInstanceBackupPolicy 接口修改目标 MongoDB 实例的自动备份策略。
DescribeBackups	调用 DescribeBackups 接口查询目标 MongoDB 实例的备份文件列表。
ModifyDBInstanceBackupURL	调用 ModifyDBInstanceBackupURL 接口获取目标 MongoDB 实例中的指定备份文件的下载地址。
DescribeDBInstanceBackupURL	调用 DescribeDBInstanceBackupURL 接口查询目标 MongoDB 实例下指定备份文件的获取进度、下载地址以及下载地址有效期等信息。
DescribeRecoverableTime	调用 DescribeRecoverableTime 接口查询目标 MongoDB 实例中备份文件的可恢复时间范围。
RestoreToNewInstance	调用 RestoreToNewInstance 接口按备份文件或按时间点将实例数据恢复至新实例。

白名单管理

API	描述
CreateAllowList	调用 CreateAllowList 接口创建一个新的 IP 白名单。
DescribeAllowLists	调用 DescribeAllowLists 接口查询当前账号下指定地域内的 IP 白名单列表。
DescribeAllowListDetail	调用 DescribeAllowListDetail 接口查询目标白名单的详细信息，包括 IP 地址和绑定的实例详情。
ModifyAllowList	调用 ModifyAllowList 接口修改目标白名单设置（例如白名单名称、IP 白名单地址、是否设置为默认白名单等）。
AssociateAllowList	调用 AssociateAllowList 接口将目标 MongoDB 实例绑定到指定 IP 白名单。
DisassociateAllowList	调用 DisassociateAllowList 接口将目标 MongoDB 实例与指定白名单解绑。
DeleteAllowList	调用 DeleteAllowList 接口删除目标白名单。

SSL 加密

API	描述
DescribeDBInstanceSSL	调用 DescribeDBInstanceSSL 接口查询目标 MongoDB 实例的 SSL 加密设置，包括功能是否已开通、SSL 证书到期时间等信息。
ModifyDBInstanceSSL	调用 ModifyDBInstanceSSL 接口修改目标 MongoDB 实例的 SSL 加密设置，包括开通、关闭加密功能，或更新 SSL 证书有效期。

参数管理

API	描述
DescribeDBInstanceParameters	调用 DescribeDBInstanceParameters 接口查询目标 MongoDB 实例支持的参数列表。
ModifyDBInstanceParameters	调用 ModifyDBInstanceParameters 接口修改目标 MongoDB 实例的指定参数。
DescribeDBInstanceParametersLog	调用 DescribeDBInstanceParametersLog 接口查询目标 MongoDB 实例在指定时间内的参数修改历史。
ModifyMultiDBInstanceParameters	调用 ModifyMultiDBInstanceParameters 接口修改目标 MongoDB 实例中的多个参数。

日志管理

API	描述
DescribeNormalLogs	调用 DescribeNormalLogs 接口查询目标 MongoDB 实例在指定时间段内的运行日志或错误日志信息。
DescribeSlowLogs	调用 DescribeSlowLogs 接口查询目标 MongoDB 实例在指定时间内的慢日志信息。

最近更新时间：2026.03.31 21:19:47

这个页面对您有帮助吗？

有用

无用