云数据库MongoDB版提供以下相关API接口。

如何使用RAM授权

API 描述
使用RAM实现MongoDB资源授权 使用阿里云的RAM(Resource Access Management)服务,您可以将您云账号下MongoDB资源的访问及管理权限授予RAM中子用户。
RAM中可授权的MongoDB资源类型 目前,可以在RAM中进行授权的资源类型仅一种:dbinstance。
RAM中可对MongoDB资源进行授权的Action 在RAM中,可以对一个MongoDB资源进行以下Action的授权。
MongoDB API的鉴权规则 当子用户通过MongoDB Open API进行资源访问时,MongoDB后台向RAM进行权限检查,以确保调用者拥有响应权限。

生命周期管理

API 描述
CreateDBInstance 该接口用于创建MongoDB副本集实例,同时也可用于克隆MongoDB副本集实例。
ModifyDBInstanceSpec 调用ModifyDBInstanceSpec接口变更MongoDB单节点或副本集实例的规格或存储空间。
DeleteDBInstance 调用DeleteDBInstance接口释放MongoDB实例。
RenewDBInstance 调用RenewDBInstance接口手动续费包年包月的MongoDB实例。
CreateShardingDBInstance 调用CreateShardingDBInstance接口创建或者克隆MongoDB分片集群实例。
CreateNode 调用CreateNode接口为MongoDB分片集群实例增加Shard节点或Mongos节点。
DeleteNode 调用DeleteNode接口删除MongoDB分片集群实例中的Shard节点或Mongos节点。
ModifyNodeSpec 调用ModifyNodeSpec接口变更MongoDB分片集群实例中节点的规格和存储空间。

实例管理

API 描述
ModifyDBInstanceDescription 调用ModifyDBInstanceDescription接口修改MongoDB实例名称。
DescribeRegions 调用DescribeRegions接口查看MongoDB实例可用的地域和可用区。
RestartDBInstance 调用RestartDBInstance接口重启MongoDB实例。
DescribeReplicaSetRole 调用DescribeReplicaSetRole接口查询MongoDB实例中的角色信息及连接信息。
DescribeShardingNetworkAddress 调用DescribeShardingNetworkAddress接口查询MongoDB分片集群实例的连接信息。
ModifyDBInstanceNetworkType 调用ModifyDBInstanceNetworkType接口切换MongoDB实例的网络类型。
ModifyDBInstanceNetExpireTime 调用ModifyDBInstanceNetExpireTime接口延长MongoDB实例的经典网络保留时长。
SwitchDBInstanceHA 调用SwitchDBInstanceHA接口切换MongoDB实例中的主备节点。
AllocatePublicNetworkAddress 调用AllocatePublicNetworkAddress接口为MongoDB实例申请公网连接地址。
ReleasePublicNetworkAddress 调用ReleasePublicNetworkAddress接口释放MongoDB实例的公网连接地址。
UpgradeDBInstanceEngineVersion 调用UpgradeDBInstanceEngineVersion接口升级MongoDB实例的数据库版本。
ModifyDBInstanceConnectionString 调用ModifyDBInstanceConnectionString接口修改MongoDB实例的连接地址。
UpgradeDBInstanceKernelVersion 调用UpgradeDBInstanceKernelVersion接口升级MongoDB实例的数据库小版本。
DescribeKernelReleaseNotes 调用DescribeKernelReleaseNotes接口查询MongoDB实例的小版本发布日志。
DestroyInstance 调用DestroyInstance接口销毁MongoDB实例。
DescribeDBInstances 调用DescribeDBInstances接口查询MongoDB实例列表。
ModifyDBInstanceMaintainTime 调用ModifyDBInstanceMaintainTime接口修改MongoDB实例的可维护时间。
DescribeDBInstanceAttribute 调用DescribeDBInstanceAttribute接口查询MongoDB实例详情。
MigrateAvailableZone 调用MigrateAvailableZone接口迁移MongoDB实例的可用区。
ModifyInstanceVpcAuthMode 调用ModifyInstanceVpcAuthMode接口开启或关闭MongoDB实例的专有网络免密访问功能。
DescribeRoleZoneInfo 调用DescribeRoleZoneInfo接口查询MongoDB实例的各节点的角色和所属的可用区

账号管理

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

安全管理

API 描述
DescribeAuditPolicy 调用DescribeAuditPolicy接口查询MongoDB实例的审计日志是否开启。
DescribeAuditRecords 调用DescribeAuditRecords接口查询MongoDB实例的审计日志。
DescribeAuditFiles 调用DescribeAuditFiles接口查询MongoDB实例的审计日志文件。
DescribeAuditLogFilter 调用DescribeAuditLogFilter接口查询MongoDB实例审计日志采集的日志类型。
ModifyAuditLogFilter 调用ModifyAuditLogFilter接口修改MongoDB实例审计日志的采集类型。
DescribeSecurityIps 调用DescribeSecurityIps接口查询MongoDB实例的IP白名单。
ModifySecurityIps 调用ModifySecurityIps接口修改MongoDB实例的IP白名单。
ModifyDBInstanceSSL 调用ModifyDBInstanceSSL接口修改MongoDB实例的SSL配置。
DescribeDBInstanceSSL 调用DescribeDBInstanceSSL接口查询MongoDB实例的SSL设置详情。
DescribeDBInstanceTDEInfo 调用DescribeDBInstanceTDEInfo接口查询MongoDB实例的透明数据加密TDE(Transparent Data Encryption)是否开启。
ModifyDBInstanceTDE 调用ModifyDBInstanceTDE接口修改MongoDB实例的透明数据加密TDE(Transparent Data Encryption)状态。
ModifyAuditPolicy 调用ModifyAuditPolicy接口设置MongoDB实例的审计日志开关或日志存储时长。

日志管理

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

性能监控管理

API 描述
DescribeDBInstancePerformance 调用DescribeDBInstancePerformance接口查询MongoDB实例性能数据。

参数管理

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

索引推荐

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

备份与恢复

API 描述
DescribeBackupPolicy 调用DescribeBackupPolicy接口查询MongoDB实例的备份策略。
ModifyBackupPolicy 调用ModifyBackupPolicy接口修改MongoDB实例的备份策略。
CreateBackup 调用CreateBackup接口手动备份MongoDB实例。
DescribeBackups 调用DescribeBackups接口查询MongoDB实例的备份列表。
RestoreDBInstance 调用RestoreDBInstance接口恢复数据至当前MongoDB实例。
DescribeBackupDBs 在为MongoDB实例执行单库恢复前,调用DescribeBackupDBs接口,查询指定的时间点或备份集内包含的数据库。

附表