本产品（Dds/2015-12-01）的OpenAPI采用RPC签名风格，签名细节参见签名机制说明。我们已经为开发者封装了常见编程语言的SDK，开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入我们的服务钉钉群（78410016550），在专家指导下进行签名对接。
在使用API前，您需要准备好身份账号及访问密钥（AccessKey），才能有效通过客户端工具（SDK、CLI等）访问API。细节请参见获取AccessKey。
创建或克隆实例
|
API |
标题 |
API概述 |
| CreateDBInstance | 创建或克隆副本集实例 | 创建或克隆云数据库MongoDB版副本集实例。 |
| CreateShardingDBInstance | 创建或克隆分片集群实例 | 创建或者克隆MongoDB分片集群实例。 |
变更实例配置
|
API |
标题 |
API概述 |
| CreateNode | 新增Shard节点或Mongos节点 | 为云数据库MongoDB分片集群实例添加Shard节点或Mongos节点。 |
| CreateNodeBatch | 批量创建节点 | 为云数据库MongoDB分片集群实例批量添加Mongos节点、Shard节点。 |
| DeleteNode | 删除分片集群实例中的节点 | 删除MongoDB分片集群实例中的Shard节点或Mongos节点。 |
| ModifyDBInstanceSpec | 变更单节点或副本集实例的规格或存储空间 | 变更云数据库MongoDB单节点实例、副本集实例和Serverless实例（仅中国站支持Serverless实例）的规格或存储空间。 |
| ModifyNodeSpec | 变更分片集群实例中节点的规格和存储空间 | 变更MongoDB分片集群实例中节点的规格和存储空间。 |
| ModifyNodeSpecBatch | 批量修改节点规格 | 变更云数据库MongoDB分片集群实例中一个或多个Mongos节点、Shard节点的配置。 |
| ModifyDBInstanceDiskType | 修改实例磁盘类型 | 修改云数据库 MongoDB 版的磁盘类型。 |
实例管理
|
API |
标题 |
API概述 |
| DeleteDBInstance | 删除数据库实例 | 释放MongoDB实例。 |
| ModifyDBInstanceMaintainTime | 修改实例的可维护时间 | 修改MongoDB实例的可维护时间。 |
| ModifyDBInstanceDescription | 修改实例名称 | 修改MongoDB实例名称。 |
| ModifyDBInstanceNetExpireTime | 延长MongoDB实例的经典网络保留时长 | 延长MongoDB实例的经典网络保留时长。 |
| UpgradeDBInstanceEngineVersion | 升级实例的数据库版本 | 升级MongoDB实例的数据库版本。 |
| UpgradeDBInstanceKernelVersion | 升级实例的数据库小版本 | 升级MongoDB实例的数据库小版本。 |
| SwitchDBInstanceHA | 切换实例中的主备节点 | 切换MongoDB实例中的主备节点。 |
| RestartDBInstance | 重启MongoDB实例 | 重启MongoDB实例。 |
| DestroyInstance | 销毁MongoDB实例 | 销毁MongoDB实例。 |
| RestartNode | 重启MongoDB实例的单个节点 | 重启MongoDB实例的单个节点。 |
续费管理
|
API |
标题 |
API概述 |
| ModifyInstanceAutoRenewalAttribute | 开启或者关闭实例的到期前自动续费功能 | 设置MongoDB实例的自动续费功能。 |
| TransformInstanceChargeType | 转换云数据库MongoDB实例的付费类型 | 转换云数据库MongoDB实例的付费类型，将按量付费（后付费）实例转换为包年包月（预付费）实例或者包年包月实例转换为按量付费实例。 |
| DescribePrice | 查询费用 | 询价 |
| DescribeRenewalPrice | 查询实例续费一个月的价格 | 查询指定MongoDB实例续费一个月的价格。 |
| TransformToPrePaid | 将按量付费实例转换为包年包月实例 | 将按量付费的MongoDB实例转换为包年包月（预付费）实例。 |
| RenewDBInstance | 手动续费包年包月的实例 | 手动续费包年包月的MongoDB实例。 |
查询实例
|
API |
标题 |
API概述 |
| DescribeDBInstanceSpecInfo | 查询实例规格的详细信息 | 查看实例规格信息详情 |
| DescribeReplicaSetRole | 查询实例中的角色信息及连接信息 | 查询MongoDB实例中的角色信息及连接信息。 |
| DescribeKernelReleaseNotes | 查询实例的小版本发布日志 | 查询MongoDB实例的小版本发布日志。 |
| DescribeAvailableEngineVersion | 查询实例可升级的版本 | 查询MongoDB实例可升级的版本。 |
| DescribeDBInstances | 查询MongoDB实例列表 | 查询MongoDB实例列表。 |
| DescribeDBInstanceSwitchLog | 查询实例的主备切换日志信息 | 查询实例的主备切换日志。 |
| DescribeDBInstanceAttribute | 查询云数据库MongoDB实例的信息 | 查询云数据库MongoDB实例的信息。 |
| DescribeRoleZoneInfo | 查询实例的各节点的角色和所属的可用区 | 查询MongoDB实例的各节点的角色和所属的可用区。 |
| DescribeInstanceAutoRenewalAttribute | 查询MongoDB实例是否为自动付费 | 查询MongoDB实例是否为自动付费。 |
| DescribeActiveOperationTaskCount | 查询MongoDB实例的运维任务数量 | 查询MongoDB实例的运维任务数量。 |
| DescribeActiveOperationTasks | 查询多个主动运维任务信息 | 查询MongoDB实例的计划内运维任务详情。 |
| DescribeActiveOperationTaskType | 查询运维任务类型和任务数量 | 查询实例的运维任务类型以及各类型的任务数量。 |
| DescribeDBInstancesOverview | 查询实例的概览信息 | 查询一个或多个云数据库MongoDB实例的概览信息。 |
| DescribeHistoryTasks | 查询任务中心的任务信息 | 查看任务中心的任务列表。 |
| DescribeHistoryTasksStat | 查询任务中心任务状态的概览信息 | 查看任务中心任务的概览信息。 |
| ModifyTaskInfo | 任务中心修改任务信息 | 任务操作，修改任务中心的任务信息。 |
| ModifyActiveOperationTasks | 修改多个主动运维任务切换时间 | 该接口用于修改云数据库MongoDB实例计划内运维任务的切换时间。 |
资源管理
|
API |
标题 |
API概述 |
| DescribeAvailableResource | 查询指定可用区的资源信息 | 查询指定可用区的资源信息。 |
| EvaluateResource | 评估是否有足够的资源 | 在新购实例或对实例进行变配之前，评估是否有足够的资源。 |
| DescribeAvailabilityZones | 查看实例支持的可用区 | 查询MongoDB实例支持的可用区列表。 |
| ModifyResourceGroup | 移动到指定资源组 | 将MongoDB实例移动到指定资源组。 |
区域管理
|
API |
标题 |
API概述 |
| DescribeRegions | 查询可以使用的阿里云地域 | 查看MongoDB实例支持的所有地域和可用区。 |
| MigrateToOtherZone | 迁移实例到其他可用区 | 迁移MongoDB实例到其他可用区。 |
| MigrateAvailableZone | 迁移实例的可用区 | 迁移MongoDB实例的可用区。 |
连接管理
|
API |
标题 |
API概述 |
| ModifyInstanceVpcAuthMode | 关闭实例的专有网络免密访问功能 | 关闭MongoDB实例的专有网络免密访问功能。 |
| ModifyDBInstanceNetworkType | 切换实例的网络类型 | 切换MongoDB实例的网络类型。 |
| ModifyDBInstanceConnectionString | 修改实例的连接地址和端口 | 修改MongoDB实例的连接地址和端口。 |
| DescribeShardingNetworkAddress | 查询MongoDB分片集群实例的连接信息 | 查询MongoDB分片集群实例的连接信息。 |
| AllocatePublicNetworkAddress | 为实例申请公网连接地址 | 分配公网地址。 |
| ReleasePublicNetworkAddress | 释放实例公网地址 | 释放MongoDB实例的公网连接地址。 |
| AllocateNodePrivateNetworkAddress | 为云数据库分片集群实例节点申请内网连接地址 | 为云数据库MongoDB分片集群实例的Shard节点或ConfigServer节点申请内网连接地址。 |
| ReleaseNodePrivateNetworkAddress | 释放节点或节点内网连接地址 | 释放分片集群实例的Shard节点或ConfigServer节点的内网连接地址。 |
标签管理
|
API |
标题 |
API概述 |
| ListTagResources | 查询实例和标签的绑定关系 | 查询MongoDB实例和标签的绑定关系。 |
| DescribeTags | 查询已有标签列表 | 查询目标地域中所有的标签信息。 |
| TagResources | 为一个或多个MongoDB实例绑定标签 | 为一个或多个MongoDB实例绑定标签。 |
| UntagResources | 将标签从实例中解绑 | 如果该标签没有绑定到其他实例，则该标签会被删除。 |
账号管理
|
API |
标题 |
API概述 |
| CreateAccount | 创建Shard账号 | 创建MongoDB云盘版分片集群实例的Shard只读账号。 |
| ResetAccountPassword | 重置MongoDB实例中root账号的密码 | 重置MongoDB实例中数据库账号的密码。 |
| ModifyAccountDescription | 修改实例中root账号的备注信息 | 修改MongoDB实例中root账号的备注信息。 |
| DescribeAccounts | 查询实例的数据库账号信息 | 查询MongoDB实例的数据库账号信息。 |
白名单和安全组
|
API |
标题 |
API概述 |
| ModifySecurityIps | 设置可以访问实例的 IP 白名单地址 | 修改MongoDB实例的IP白名单。 |
| ModifySecurityGroupConfiguration | 更改MongoDB实例已绑定的ECS安全组 | 更改MongoDB实例已绑定的ECS安全组。 |
| DescribeSecurityIps | 查询MongoDB实例的IP白名单 | 查询MongoDB实例的IP白名单。 |
| DescribeSecurityGroupConfiguration | 查询MongoDB实例绑定的ECS安全组信息 | 查询MongoDB实例绑定的ECS安全组信息。 |
| ModifyGlobalSecurityIPGroup | 修改全局IP白名单模板 | 修改云数据库 MongoDB 版的全局IP白名单模板。 |
| DescribeGlobalSecurityIPGroup | 查询全局IP白名单模板 | 查询全局IP白名单模板。 |
| ModifyGlobalSecurityIPGroupName | 修改全局IP白名单模板名称 | 修改全局IP白名单模板名称。 |
| DescribeGlobalSecurityIPGroupRelation | 查询实例与全局IP白名单模板关系映射 | 查询实例与全局IP白名单模板关系映射。 |
| CreateGlobalSecurityIPGroup | 创建全局IP白名单模板 | 创建全局IP白名单模板。 |
| ModifyGlobalSecurityIPGroupRelation | 修改全局白名单模板和实例的映射关系 | 修改全局白名单模板与MongoDB实例的映射关系。 |
| DeleteGlobalSecurityIPGroup | 删除全局IP白名单模板 | 删除全局IP白名单模板。 |
密钥
|
API |
标题 |
API概述 |
| ModifyDBInstanceTDE | 修改MongoDB实例的透明数据加密TDE状态 | 修改MongoDB实例的透明数据加密TDE（Transparent Data Encryption）状态。 |
| CheckCloudResourceAuthorized | 查询KMS密钥是否已授权给实例 | 查询KMS密钥是否已授权给MongoDB实例。 |
| DescribeUserEncryptionKeyList | 查询实例的自定义密钥列表 | 查询实例的自定义密钥列表。 |
| DescribeDBInstanceEncryptionKey | 查询MongoDB实例的某个密钥的详情 | 查询MongoDB实例的某个密钥的详情。 |
| DescribeDBInstanceTDEInfo | 查询MongoDB实例的透明数据加密TDE是否开启 | 查询MongoDB实例的透明数据加密TDE（Transparent Data Encryption）是否开启。 |
| DescribeKmsKeys | 查询云盘加密可选择的Kms密钥 | 查询云盘加密可选择的Kms密钥。 |
SSL加密
|
API |
标题 |
API概述 |
| ModifyDBInstanceSSL | 修改MongoDB实例的SSL链路配置 | 修改MongoDB实例的SSL配置。 |
| DescribeDBInstanceSSL | 查询MongoDB实例的SSL设置详情 | 查询MongoDB实例的SSL设置详情。 |
审计日志
|
API |
标题 |
API概述 |
| ModifyAuditLogFilter | 修改实例审计日志的采集类型 | 修改MongoDB实例审计日志的采集类型。 |
| ModifyAuditPolicy | 设置实例的审计日志开关或日志存储时长 | 设置MongoDB实例的审计日志开关或日志存储时长。 |
| DescribeAuditRecords | 查询实例的审计日志 | 查询MongoDB实例的审计日志。 |
| DescribeAuditPolicy | 查询审计日志是否开启 | 查询MongoDB实例的审计日志是否开启。 |
| DescribeAuditLogFilter | 查询审计日志采集日志类型 | 查询MongoDB实例审计日志采集的日志类型。 |
| DescribeMongoDBLogConfig | 查看日志服务的配置 | 查看MongoDB日志服务的配置。 |
日志管理
|
API |
标题 |
API概述 |
| DescribeSlowLogRecords | 查询实例运行出现的慢操作日志明细 | 查询MongoDB实例运行出现的慢日志明细。 |
| DescribeErrorLogRecords | 查询实例的错误日志 | 查询MongoDB实例的错误日志。 |
| DescribeRunningLogRecords | 查询实例的运行日志 | 查询MongoDB实例的运行日志。 |
性能监控
|
API |
标题 |
API概述 |
| ModifyDBInstanceMonitor | 设置MongoDB实例的监控采集粒度 | 设置MongoDB实例的监控采集粒度。 |
| DescribeDBInstancePerformance | 查询实例性能数据 | 查询MongoDB实例性能数据。 |
| DescribeDBInstanceMonitor | 查询MongoDB实例的监控采集粒度 | 查询MongoDB实例的监控采集粒度。 |
参数管理
|
API |
标题 |
API概述 |
| ModifyParameters | 修改MongoDB实例的参数 | 修改MongoDB实例的参数。 |
| DescribeParameterModificationHistory | 查询实例参数的修改记录 | 查询MongoDB实例参数的修改记录。 |
| DescribeParameterTemplates | 查询实例默认的参数模板列表 | 查询MongoDB实例默认的参数模板列表。 |
| DescribeParameters | 查询实例的参数配置信息 | 查询MongoDB实例的参数配置信息。 |
备份与恢复
|
API |
标题 |
API概述 |
| CreateBackup | 手动备份实例 | 创建MongoDB实例备份。 |
| ModifyBackupPolicy | 修改实例的备份策略 | 修改MongoDB实例的备份策略。 |
| DescribeBackupPolicy | 查看实例的自动备份策略 | 查询MongoDB实例的备份策略。 |
| DescribeBackups | 查询实例的备份列表 | 查询MongoDB实例的备份列表。 |
| DescribeBackupDBs | 查询指定的时间点或备份集内包含的数据库 | 在为MongoDB实例执行单库恢复前，您可以调用本接口查询指定的时间点或备份集内包含的数据库。 |
| DescribeRestoreDBInstanceList | 查询MongoDB实例的备份恢复实例 | 查询MongoDB实例7天以内的备份恢复实例列表。 |
| CheckRecoveryCondition | 检查实例是否满足数据恢复条件 | 检查MongoDB实例是否满足数据恢复的条件。 |
| TransferClusterBackup | 切换至集群备份模式 | 将云数据库 MongoDB 版分片集群实例的备份模式切换为集群备份模式。切换至集群备份模式后，实例将支持高频备份。 |
| DescribeClusterBackups | 查询集群备份集列表 | 查询云数据库 MongoDB 版云盘版分片集群的集群备份集列表。 |
| DescribeClusterRecoverTime | 查询分片集群可恢复时间段 | 查询云数据库 MongoDB 版云盘版分片集群实例的可恢复时间。 |
| DescribeBackupStorage | 查询实例的备份使用量 | 查询MongoDB云盘版副本集或分片集群的备份使用量。 |
| DescribeBackupTasks | 查询实例进行中的备份任务 | 查询MongoDB云盘版副本集或分片集进行中的备份任务。 |
| DescribeInstanceRecoverTime | 查询副本集实例的可恢复时间 | 查询云数据库 MongoDB 版云盘版副本集实例的可恢复时间。 |
其他
|
API |
标题 |
API概述 |
| AllocateDBInstanceSrvNetworkAddress | 申请Srv地址 | 为云数据库 MongoDB 版实例申请Srv地址 |
| ModifySrvNetworkAddress | 修改MongoDB实例的SRV连接地址 | 修改MongoDB实例的SRV连接地址 |
该文章对您有帮助吗？