You need to enable JavaScript to run this app.
导航
文档数据库 MongoDB 版
  • 文档首页
    • /文档数据库 MongoDB 版/API 参考/API 发布历史
API 发布历史
最近更新时间：2024.12.04 11:51:45首次发布时间：2024.07.10 22:19:49
我的收藏

本文汇总了文档数据库 MongoDB 版 API 接口变更动态供您参考。

2024 年 12 月

API发布时间变更记录关联功能

新增 CreateDBAccount

2024-12-03

新增接口，用于为目标 MongoDB 实例创建账号。

创建账号

新增 UpdateDBAccountPrivilege

新增接口，用于修改目标 MongoDB 实例中指定账号的权限或账号描述。

修改账号权限

新增 DeleteDBAccount

新增接口，用于删除目标 MongoDB 实例中的指定账号。

删除账号

新增 ModifyMultiDBInstanceParameters新增接口，用于修改目标 MongoDB 实例的多个参数。修改实例参数

2024 年 10 月

API发布时间变更记录关联功能
修改 DescribeDBInstanceBackupPolicy2024-10-17返回参数 DataFullBackupTime 由 UTC+8 时间改为 UTC 时间。自动备份
修改 CreateAllowList请求参数新增 ProjectName 字段，用于指定白名单所属的项目。创建白名单

修改 DescribeAllowLists

  • 请求参数新增 ProjectName 字段，用于筛选指定项目下的白名单信息。
  • 返回参数 AllowLists 结构体中新增 ProjectName 字段，用于展示白名单所属的项目。

白名单管理

修改 DescribeAllowListDetail返回参数新增 ProjectName 字段，用于展示白名单所属的项目；AssociatedInstances 结构体中新增 ProjectName 字段，用于展示实例所属的项目。

2024 年 09 月

API发布时间变更记录关联功能
修改 CreateDBInstance2024-09-09请求参数 DBEngineVersion 新增支持 MongoDB_4_2 和 MongoDB_6_0 取值，用于创建 MongoDB 4.2 和 6.0 版本实例。创建实例

2024 年 08 月

API发布时间变更记录关联功能
新增 DescribeSlowLogs2024-08-15新增接口，用于查询目标 MongoDB 实例在指定时间内的慢日志信息。查询慢日志

新增 DescribeNormalLogs

新增接口，用于查询目标 MongoDB 实例在指定时间段内的运行日志或错误日志信息。

修改 DescribeDBAccounts

  • 请求参数 AccountName 允许更多取值，用于查询非 root 账号的详情。
  • 请求参数新增 AuthDB 字段，用于筛选属于指定数据库的账号。
  • 返回参数 Accounts 结构体中的 AccountType 支持更多取值，用于返回不同类型的账号。
  • 返回参数新增支持 AuthDB、CreateTime、ModifyTime 和 AccountDesc 字段，分别用于展示实例所属的数据库、账号创建时间、更新时间和账号描述信息。

查看账号信息

修改 ResetDBAccount

请求参数新增 AuthDB 和 ResetDBAccount 字段，分别用于指定账号所属的数据库，以及是否重置 root 账号权限为初始状态。

2024 年 06 月

API发布时间变更记录关联功能

修改 CreateDBInstance

2024-06-24

  • 请求参数新增 NodeAvailabilityZone 字段，用于指定新建实例的只读节点信息，包括只读节点数量和所在可用区。
  • 请求参数 DBEngineVersion 新增支持 MongoDB_4_4 取值，用于创建 MongoDB 4.4 版本实例。

创建实例

修改 DescribeDBInstances

返回参数新增 ReadOnlyNodeNumber 字段，用于展示实例中的只读节点数量。

修改 DescribeDBInstanceDetail

  • 返回参数新增 ReadOnlyNodeNumber 字段，用于展示实例中的只读节点数量。
  • 返回参数的 Nodes 结构体中，NodeRole 字段新增支持 ReadOnly 取值，用于区分副本集实例或分片集群实例 Shard 节点中主、从、隐藏和只读节点角色。

修改 RestoreToNewInstance

请求参数新增 NodeAvailabilityZone 字段，用于设置只读节点配置。

修改 DescribeDBEndpoint返回参数的 DBAddresses 结构体中，AddressType 字段新增支持 ReadOnly 取值，用于展示实例中只读节点的连接地址信息。连接地址介绍

2024 年 04 月

API发布时间变更记录关联功能
新增 CreateBackup2024-04-25新增接口，用于为目标 MongoDB 实例手动创建备份。手动备份
新增 DescribeDBInstanceBackupPolicy新增接口，用于查询目标 MongoDB 实例的自动备份策略。自动备份
新增 DescribeBackups新增接口，用于查询目标 MongoDB 实例的备份文件列表。管理备份文件
新增 ModifyDBInstanceBackupURL新增接口，用于获取目标 MongoDB 实例中的指定备份文件。
新增 DescribeDBInstanceBackupURL新增接口，用于查询目标 MongoDB 实例下指定备份文件的下载地址信息。
新增 DescribeRecoverableTime新增接口，用于查询目标 MongoDB 实例中备份文件的可恢复时间范围。按时间点恢复

新增 RestoreToNewInstance

新增接口，用于按备份文件或按时间点将实例数据恢复至新实例。

2024 年 03 月

API发布时间变更记录关联功能
修改 DescribeAvailabilityZones2024-03-25请求参数 RegionId 由选填改为必填。服务地址

2023 年 06 月

API发布时间变更记录关联功能

修改 DescribeDBInstanceDetail

2023-06-05

  • 返回参数新增 PrivateEndpoint 字段，用于展示实例私网连接地址的字符串信息。
  • 返回参数 NodeRole 字段新增支持 Hidden 取值，用于区分主、从和隐藏节点角色。

查看实例信息

修改 DescribeDBInstances返回参数新增 PrivateEndpoint 字段，用于展示实例私网连接地址的字符串信息。
新增 SwitchDBMaster新增接口，用于手动切换目标 MongoDB 实例的主从节点。切换主节点

2023 年 04 月

API发布时间变更记录关联功能
修改 CreateDBInstance2023-04-12请求参数 DBEngineVersion 新增支持 MongoDB_5_0 取值，用于创建 MongoDB 5.0 版本实例。创建实例
修改 DescribeNodeSpecs返回参数新增 ConfigServerNodeSpecs 结构体，用于展示 ConfigServer 节点的规格列表。产品规格

2023 年 03 月

API发布时间变更记录关联功能
修改 DescribeDBInstances2023-03-07返回参数增加 StorageType 字段，用于展示实例的存储类型。查看实例信息
修改 DescribeDBInstanceDetail

2023 年 01 月

API发布时间变更记录关联功能
修改 CreateDBInstance2023-01-16请求参数新增 Tags 字段，用于为新建实例绑定标签。创建实例

修改 DescribeDBInstances

  • 请求参数新增 TagFilters 结构体，用于筛选绑定对应标签的实例。
  • 返回参数新增 Tags 结构体，用于展示实例已绑定的标签。

查看实例信息

修改 DescribeDBInstanceDetail

  • 返回参数的 Nodes、ConfigServers、Mongos 结构体中分别新增 ZoneId 字段，用于展示对应实例或组件节点所在的可用区。
  • 返回参数新增 Tags 结构体，用于展示实例已绑定的标签。
新增 AddTagsToResource新增接口，用于为目标 MongoDB 实例绑定标签。绑定或添加标签
新增 RemoveTagsFromResource新增接口，用于为一个或多个实例解绑标签。解绑或删除标签

2022 年 11 月

API发布时间变更记录关联功能
新增 DescribeDBInstanceSSL2022-11-03新增接口，查询目标 MongoDB 实例的 SSL 加密设置，包括功能是否已开通、SSL 证书到期时间等信息。设置 SSL 加密
新增 ModifyDBInstanceSSL新增接口，用于修改目标 MongoDB 实例的 SSL 加密设置，包括开通、关闭加密功能，或更新 SSL 证书有效期。

2022 年 08 月

API发布时间变更记录关联功能
新增 DescribeDBInstanceParameters2022-08-03新增接口，用于查询目标 MongoDB 实例支持的参数信息列表。参数支持
新增 ModifyDBInstanceParameters新增接口，用于修改目标 MongoDB 实例的指定参数。修改实例参数
新增 DescribeDBInstanceParametersLog新增接口，用于查询指定时间内目标 MongoDB 实例的参数修改历史。查看参数修改历史

2022 年 07 月

API发布时间变更记录关联功能

修改 ModifyDBInstanceSpec

2022-07-04

请求参数新增 ShardNumber 和 MongosNodeNumber 字段，用于变更分片集群实例的 Shard 分片或 Mongos 节点的数量。

2022 年 05 月

API发布时间变更记录关联功能
修改 CreateDBInstance2022-05-31请求参数新增 ProjectName 字段，用于指定新建实例的所属项目。创建实例
修改 DescribeDBInstanceDetail返回参数新增 ProjectName 字段，用于展示实例的所属项目。查看实例信息
修改 DescribeDBInstances
修改 CreateDBEndpoint请求参数新增 EipIds 字段，用于申请公网地址时为公网地址绑定 EIP。申请公网地址

修改 DescribeDBEndpoint

  • 返回参数新增 EipId 字段，用于展示实例公网连接地址所绑定的 EIP 信息。
  • 返回参数新增 SubnetId 字段，用于展示实例所属的子网信息。

连接地址介绍

修改 DeleteDBEndpoint请求参数新增 MongosNodeIds 字段，用于指定需要释放公网连接地址的 Mongos 节点 ID。释放公网地址

2022 年 04 月

API发布时间变更记录关联功能
新增 DescribeRegions2022-04-12新增接口，用于查询文档数据库 MongoDB 版可用的地域资源信息。服务地址
新增 DescribeAvailabilityZones新增接口，用于查询 MongoDB 实例在指地域定或所有地域下的可用区资源信息。
新增 CreateDBInstance新增接口，用于创建 MongoDB 实例。创建实例
新增 DescribeNodeSpecs新增接口，用于查询可创建 MongoDB 实例的支持的节点规格信息。产品规格
新增 DescribeDBInstances新增接口，用于查询一个或多个 MongoDB 实例的基本信息。查看实例信息
新增 DescribeDBInstanceDetail新增接口，用于查询目标 MongoDB 实例的详细信息。
新增 RestartDBInstance新增接口，用于重启目标 MongoDB 实例。重启实例

新增 ModifyDBInstanceSpec

新增接口，用于目标 MongoDB 实例的配置（例如节点规格或存储空间）。

新增 ModifyDBInstanceName新增接口，用于修改目标 MongoDB 实例的实例名称。查看实例信息
新增 DeleteDBInstance新增接口，用于删除目标 MongoDB 实例。删除按量计费实例
新增 ModifyDBInstanceChargeType新增接口，用于修改目标 MongoDB 实例的计费类型。转包年包月

新增 ResetDBAccount

新增接口，用于重置目标 MongoDB 实例中指定账号的密码。

新增 DescribeDBAccounts新增接口，用于查询目标 MongoDB 实例下的账号信息。查看账号信息
新增 CreateDBEndpoint新增接口，用于为目标 MongoDB 实例创建连接地址。申请私网地址
新增 DescribeDBEndpoint新增接口，用于查询目标 MongoDB 实例下的连接地址信息。连接地址介绍
新增 DeleteDBEndpoint新增接口，用于删除目标 MongoDB 实例的连接地址。释放私网地址
新增 CreateAllowList新增接口，用于创建一个新的 IP 白名单。创建白名单
新增 DescribeAllowLists新增接口，用于查询当前账号下指定地域内的所有 IP 白名单信息。白名单管理
新增 DescribeAllowListDetail新增接口，用于查询目标白名单的详细信息，包括 IP 地址和绑定的实例详情。
新增 ModifyAllowList新增接口，用于修改目标白名单信息（例如白名单名称、IP 白名单地址等）。编辑白名单
新增 AssociateAllowList新增接口，用于将目标 MongoDB 实例绑定到指定 IP 白名单中。绑定实例和白名单
新增 DisassociateAllowList新增接口，用于将目标 MongoDB 实例从指定 IP 白名单中解绑。解绑实例和白名单
新增 DeleteAllowList新增接口，用于删除目标白名单。删除白名单