文档中心

API 概览

最近更新时间：2023.09.13 14:57:44

首次发布时间：2022.04.12 11:06:53

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

说明

除 Describe 类型（如 DescribeDBInstances）的接口外，其他接口调用时均为异步执行。
单个地域下，文档数据库 MongoDB 版的 API 流控限制为 20 次/秒，即单个火山引擎账号每秒钟调用单个 API 接口的次数不可超过 20。若超过该限制，会导致 API 请求执行失败，并提示 AccountFlowLimitExceeded 报错。

地域和可用区

API	描述
DescribeRegions	调用 DescribeRegions 接口查询文档数据库 MongoDB 版可用的地域资源信息。
DescribeAvailabilityZones	调用 DescribeAvailabilityZones 接口查询 MongoDB 实例在指地域定或所有地域下的可用区资源信息。

实例管理

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

标签管理

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

计费管理

API	描述
ModifyDBInstanceChargeType	调用 ModifyDBInstanceChargeType 接口修改指定实例的计费类型。

账号管理

API	描述
DescribeDBAccounts	调用 DescribeDBAccounts 接口查询指定实例下的所有账号信息。
ResetDBAccount	调用 ResetDBAccount 接口重置 MongoDB 实例中指定账号的密码。

连接管理

API	描述
DescribeDBEndpoint	调用 DescribeDBEndpoint 接口查询指定实例的连接地址信息。
CreateDBEndpoint	调用 CreateDBEndpoint 接口创建指定实例的连接地址。
DeleteDBEndpoint	调用 DeleteDBEndpoint 接口删除指定实例的连接地址。

白名单管理

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

SSL 加密

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

参数管理

API	描述
DescribeDBInstanceParameters	调用 DescribeDBInstanceParameters 接口查询指定实例支持的参数信息列表。
ModifyDBInstanceParameters	调用 ModifyDBInstanceParameters 接口修改指定实例的参数。
DescribeDBInstanceParametersLog	调用 DescribeDBInstanceParametersLog 接口查看指定时间内目标实例的参数修改历史。

地域和可用区

实例管理

标签管理

计费管理

账号管理

连接管理

白名单管理

SSL 加密

参数管理