本文介绍云数据库MongoDB提供的API接口。

创建或克隆实例

API 描述
CreateDBInstance 调用CreateDBInstance接口创建或克隆MongoDB副本集实例。
CreateShardingDBInstance 调用CreateShardingDBInstance接口创建或克隆MongoDB分片集群实例。
CreateServerlessDBInstance 调用CreateServerlessDBInstance接口创建MongoDB Serverless实例。

变更实例配置

API 描述
ModifyDBInstanceSpec 调用ModifyDBInstanceSpec接口变更MongoDB单节点实例、副本集实例或Serverless实例的规格或存储空间。
ModifyNodeSpec 调用ModifyNodeSpec接口变更MongoDB分片集群实例中节点的规格和存储空间。
ModifyNodeSpecBatch 调用ModifyNodeSpecBatch接口变更云数据库MongoDB分片集群实例中一个或多个Mongos节点、Shard节点的配置。
CreateNode 调用CreateNode接口为MongoDB分片集群实例增加Shard节点或Mongos节点。
CreateNodeBatch 调用CreateNodeBatch接口为云数据库MongoDB分片集群实例批量添加Mongos节点、Shard节点。
DeleteNode 调用DeleteNode接口删除MongoDB分片集群实例中的Shard节点或Mongos节点。

实例管理

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

查询实例信息

API 描述
DescribeReplicaSetRole 调用DescribeReplicaSetRole接口查询MongoDB实例中的角色信息及连接信息。
DescribeKernelReleaseNotes 调用DescribeKernelReleaseNotes接口查询MongoDB实例的小版本发布日志。
DescribeAvailableEngineVersion 调用DescribeAvailableEngineVersion接口查询MongoDB实例可升级的版本。
DescribeDBInstances 调用DescribeDBInstances接口查询MongoDB实例列表。
DescribeDedicatedClusterInstanceList 调用DescribeDedicatedClusterInstanceList查看专属集群实例的列表。
DescribeDBInstanceAttribute 调用DescribeDBInstanceAttribute接口查询MongoDB实例详情。
DescribeRoleZoneInfo 调用DescribeRoleZoneInfo接口查询MongoDB实例的各节点的角色和所属的可用区。
DescribeInstanceAutoRenewalAttribute 调用DescribeInstanceAutoRenewalAttribute接口查询MongoDB实例是否为自动付费。
DescribeActiveOperationTaskCount 调用DescribeActiveOperationTaskCount接口查询MongoDB实例的运维任务数量。
DescribeActiveOperationTaskType 调用DescribeActiveOperationTaskType接口查询MongoDB实例的运维任务类型以及各类型的任务数量。

资源管理

API 描述
EvaluateResource 调用EvaluateResource接口用于在新购实例或对实例进行变配前评估是否有足够的资源。
DescribeAvailableResource 调用DescribeAvailableResource接口查询指定可用区内可创建的实例。
ModifyResourceGroup 调用ModifyResourceGroup接口将MongoDB实例移动到指定资源组。

区域管理

API 描述
MigrateToOtherZone 调用MigrateToOtherZone接口迁移MongoDB实例到其他可用区。
DescribeRegions 调用DescribeRegions接口查看MongoDB实例可用的地域和可用区。
MigrateAvailableZone 调用MigrateAvailableZone接口迁移MongoDB实例的可用区。

连接管理

API 描述
AllocatePublicNetworkAddress 调用AllocatePublicNetworkAddress接口为MongoDB实例申请公网连接地址。
ReleasePublicNetworkAddress 调用ReleasePublicNetworkAddress接口释放MongoDB实例的公网连接地址。
ModifyInstanceVpcAuthMode 调用ModifyInstanceVpcAuthMode接口开启或关闭MongoDB实例的专有网络免密访问功能。
DescribeShardingNetworkAddress 调用DescribeShardingNetworkAddress接口查询MongoDB分片集群实例的连接信息。
ModifyDBInstanceNetworkType 调用ModifyDBInstanceNetworkType接口切换MongoDB实例的网络类型。
ModifyDBInstanceConnectionString 调用ModifyDBInstanceConnectionString接口修改MongoDB实例的连接地址。
ReleaseNodePrivateNetworkAddress 调用ReleaseNodePrivateNetworkAddress接口释放MongoDB分片集群实例的Shard节点或ConfigServer节点的内网连接地址。
AllocateNodePrivateNetworkAddress 调用AllocateNodePrivateNetworkAddress接口为MongoDB分片集群实例的Shard节点或ConfigServer节点申请内网连接地址。

标签管理

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

账号管理

API 描述
DescribeAccounts 调用DescribeAccounts接口查询MongoDB实例的数据库账号信息。
ResetAccountPassword 调用ResetAccountPassword接口重置MongoDB实例中root账号的密码。
ModifyAccountDescription 调用ModifyAccountDescription接口修改MongoDB实例中root账号的备注信息。

白名单和安全组

API 描述
DescribeSecurityGroupConfiguration 调用DescribeSecurityGroupConfiguration接口查询MongoDB实例绑定的ECS安全组信息。
ModifySecurityGroupConfiguration 调用ModifySecurityGroupConfiguration接口更改MongoDB实例已绑定的ECS安全组。
DescribeSecurityIps 调用DescribeSecurityIps接口查询MongoDB实例的IP白名单。
ModifySecurityIps 调用ModifySecurityIps接口修改MongoDB实例的IP白名单。

密钥

API 描述
CheckCloudResourceAuthorized 调用CheckCloudResourceAuthorized接口查询KMS密钥是否已授权给MongoDB实例。
DescribeUserEncryptionKeyList 调用DescribeUserEncryptionKeyList接口查询实例的自定义密钥列表。
DescribeDBInstanceEncryptionKey 调用DescribeDBInstanceEncryptionKey接口查询MongoDB实例的某个密钥的详情。
DescribeDBInstanceTDEInfo 调用DescribeDBInstanceTDEInfo接口查询MongoDB实例的透明数据加密TDE（Transparent Data Encryption）是否开启。
ModifyDBInstanceTDE 调用ModifyDBInstanceTDE接口修改MongoDB实例的透明数据加密TDE（Transparent Data Encryption）状态。

SSL加密

API 描述
ModifyDBInstanceSSL 调用ModifyDBInstanceSSL接口修改MongoDB实例的SSL配置。
DescribeDBInstanceSSL 调用DescribeDBInstanceSSL接口查询MongoDB实例的SSL设置详情。

审计日志

API 描述
DescribeAuditRecords 调用DescribeAuditRecords接口查询MongoDB实例的审计日志。
DescribeAuditPolicy 调用DescribeAuditPolicy接口查询MongoDB实例的审计日志是否开启。
ModifyAuditLogFilter 调用ModifyAuditLogFilter接口修改MongoDB实例审计日志的采集类型。
DescribeAuditLogFilter 调用DescribeAuditLogFilter接口查询MongoDB实例审计日志采集的日志类型。
ModifyAuditPolicy 调用ModifyAuditPolicy接口设置MongoDB实例的审计日志开关或日志存储时长。

日志管理

API 描述
DescribeSlowLogRecords 调用DescribeSlowLogRecords接口查询MongoDB实例运行出现的慢操作日志明细。
DescribeErrorLogRecords 调用DescribeErrorLogRecords接口查询MongoDB实例的错误日志。
DescribeRunningLogRecords 调用DescribeRunningLogRecords接口查询MongoDB实例的运行日志。
DescribeMongoDBLogConfig 调用DescribeMongoDBLogConfig接口查看MongoDB日志服务的配置。

性能监控管理

API 描述
DescribeDBInstancePerformance 调用DescribeDBInstancePerformance接口查询MongoDB实例性能数据。
ModifyDBInstanceMonitor 调用ModifyDBInstanceMonitor接口设置MongoDB实例的监控采集粒度。
DescribeDBInstanceMonitor 调用DescribeDBInstanceMonitor接口查询MongoDB实例的监控采集粒度。

参数管理

API 描述
DescribeParameterModificationHistory 调用DescribeParameterModificationHistory接口查询MongoDB实例参数的修改记录。
DescribeParameters 调用DescribeParameters接口查询MongoDB实例的参数配置信息。
DescribeParameterTemplates 调用DescribeParameterTemplates接口查询MongoDB实例默认的参数模板列表。
ModifyParameters 调用ModifyParameters接口修改MongoDB实例的参数。

索引推荐

API 描述
CreateRecommendationTask 调用CreateRecommendationTask接口为MongoDB实例创建索引分析任务。
DescribeAvailableTimeRange 调用DescribeAvailableTimeRange接口查询MongoDB实例索引分析报告的分析时间段和生成状态。

备份与恢复

API 描述
DescribeBackupPolicy 调用DescribeBackupPolicy接口查询MongoDB实例的备份策略。
ModifyBackupPolicy 调用ModifyBackupPolicy接口修改MongoDB实例的备份策略。
CreateBackup 调用CreateBackup接口手动备份MongoDB实例。
DescribeBackups 调用DescribeBackups接口查询MongoDB实例的备份列表。
RestoreDBInstance 调用RestoreDBInstance接口恢复数据至当前MongoDB实例。
DescribeBackupDBs 调用DescribeBackupDBs接口用于执行单库恢复前，查询指定的时间点或备份集内包含的数据库。
CheckRecoveryCondition 调用CheckRecoveryCondition接口检查MongoDB实例是否满足数据恢复的条件。

续费管理

API 描述
DescribePrice 调用DescribePrice接口查询创建MongoDB实例、升级配置或续费操作产生的费用。
ModifyInstanceAutoRenewalAttribute 调用ModifyInstanceAutoRenewalAttribute接口设置MongoDB实例的自动续费功能。
TransformToPrePaid 调用TransformToPrePaid接口将按量付费的MongoDB实例转换为包年包月（预付费）实例。
RenewDBInstance 调用RenewDBInstance接口手动续费包年包月的MongoDB实例。
DescribeRenewalPrice 调用DescribeRenewalPrice接口查询指定MongoDB实例续费一个月的价格。

附表