本文介紹云數(shù)據(jù)庫MongoDB提供的API接口。

創(chuàng)建或克隆實例

API 描述
CreateDBInstance 調(diào)用CreateDBInstance接口創(chuàng)建或克隆MongoDB副本集實例。
CreateShardingDBInstance 調(diào)用CreateShardingDBInstance接口創(chuàng)建或克隆MongoDB分片集群實例。

變更實例配置

API 描述
ModifyDBInstanceSpec 調(diào)用ModifyDBInstanceSpec接口變更MongoDB單節(jié)點實例、副本集實例或Serverless實例的規(guī)格或存儲空間。
ModifyNodeSpec 調(diào)用ModifyNodeSpec接口變更MongoDB分片集群實例中節(jié)點的規(guī)格和存儲空間。
ModifyNodeSpecBatch 調(diào)用ModifyNodeSpecBatch接口變更MongoDB分片集群實例中一個或多個Mongos節(jié)點、Shard節(jié)點的配置。
CreateNode 調(diào)用CreateNode接口為MongoDB分片集群實例增加Shard節(jié)點或Mongos節(jié)點。
CreateNodeBatch 調(diào)用CreateNodeBatch接口為MongoDB分片集群實例批量添加Mongos節(jié)點、Shard節(jié)點。
DeleteNode 調(diào)用DeleteNode接口刪除MongoDB分片集群實例中的Shard節(jié)點或Mongos節(jié)點。

實例管理

API 描述
UpgradeDBInstanceEngineVersion 調(diào)用UpgradeDBInstanceEngineVersion接口升級MongoDB實例的數(shù)據(jù)庫版本。
UpgradeDBInstanceKernelVersion 調(diào)用UpgradeDBInstanceKernelVersion接口升級MongoDB實例的數(shù)據(jù)庫小版本。
ModifyDBInstanceMaintainTime 調(diào)用ModifyDBInstanceMaintainTime接口修改MongoDB實例的可維護時間。
ModifyDBInstanceDescription 調(diào)用ModifyDBInstanceDescription接口修改MongoDB實例名稱。
ModifyDBInstanceNetExpireTime 調(diào)用ModifyDBInstanceNetExpireTime接口延長MongoDB實例的經(jīng)典網(wǎng)絡(luò)保留時長。
SwitchDBInstanceHA 調(diào)用SwitchDBInstanceHA接口切換MongoDB實例中的主備節(jié)點。
RestartDBInstance 調(diào)用RestartDBInstance接口重啟MongoDB實例。
DeleteDBInstance 調(diào)用DeleteDBInstance接口釋放MongoDB實例。
DestroyInstance 調(diào)用DestroyInstance接口銷毀MongoDB實例。

查詢實例信息

API 描述
DescribeDBInstancesOverview 調(diào)用DescribeDBInstancesOverview接口查詢一個或多個MongoDB實例的概覽信息。
DescribeReplicaSetRole 調(diào)用DescribeReplicaSetRole接口查詢MongoDB實例中的角色信息及連接信息。
DescribeKernelReleaseNotes 調(diào)用DescribeKernelReleaseNotes接口查詢MongoDB實例的小版本發(fā)布日志。
DescribeAvailableEngineVersion 調(diào)用DescribeAvailableEngineVersion接口查詢MongoDB實例可升級的版本。
DescribeDBInstances 調(diào)用DescribeDBInstances接口查詢MongoDB實例列表。
DescribeDBInstanceAttribute 調(diào)用DescribeDBInstanceAttribute接口查詢MongoDB實例詳情。
DescribeRoleZoneInfo 調(diào)用DescribeRoleZoneInfo接口查詢MongoDB實例的各節(jié)點的角色和所屬的可用區(qū)。
DescribeInstanceAutoRenewalAttribute 調(diào)用DescribeInstanceAutoRenewalAttribute接口查詢MongoDB實例是否為自動付費。
DescribeActiveOperationTaskCount 調(diào)用DescribeActiveOperationTaskCount接口查詢MongoDB實例的運維任務(wù)數(shù)量。
DescribeActiveOperationTaskType 調(diào)用DescribeActiveOperationTaskType接口查詢MongoDB實例的運維任務(wù)類型以及各類型的任務(wù)數(shù)量。

資源管理

API 描述
EvaluateResource 調(diào)用EvaluateResource接口用于在新購實例或?qū)嵗M行變配前評估是否有足夠的資源。
DescribeAvailableResource 調(diào)用DescribeAvailableResource接口查詢指定可用區(qū)內(nèi)可創(chuàng)建的實例。
ModifyResourceGroup 調(diào)用ModifyResourceGroup接口將MongoDB實例移動到指定資源組。

區(qū)域管理

API 描述
MigrateToOtherZone 調(diào)用MigrateToOtherZone接口遷移MongoDB實例到其他可用區(qū)。
DescribeRegions 調(diào)用DescribeRegions接口查看MongoDB實例可用的地域和可用區(qū)。
MigrateAvailableZone 調(diào)用MigrateAvailableZone接口遷移MongoDB實例的可用區(qū)。

連接管理

API 描述
AllocatePublicNetworkAddress 調(diào)用AllocatePublicNetworkAddress接口為MongoDB實例申請公網(wǎng)連接地址。
ReleasePublicNetworkAddress 調(diào)用ReleasePublicNetworkAddress接口釋放MongoDB實例的公網(wǎng)連接地址。
ModifyInstanceVpcAuthMode 調(diào)用ModifyInstanceVpcAuthMode接口開啟或關(guān)閉MongoDB實例的專有網(wǎng)絡(luò)免密訪問功能。
DescribeShardingNetworkAddress 調(diào)用DescribeShardingNetworkAddress接口查詢MongoDB分片集群實例的連接信息。
ModifyDBInstanceNetworkType 調(diào)用ModifyDBInstanceNetworkType接口切換MongoDB實例的網(wǎng)絡(luò)類型。
ModifyDBInstanceConnectionString 調(diào)用ModifyDBInstanceConnectionString接口修改MongoDB實例的連接地址。
ReleaseNodePrivateNetworkAddress 調(diào)用ReleaseNodePrivateNetworkAddress接口釋放MongoDB分片集群實例的Shard節(jié)點或ConfigServer節(jié)點的內(nèi)網(wǎng)連接地址。
AllocateNodePrivateNetworkAddress 調(diào)用AllocateNodePrivateNetworkAddress接口為MongoDB分片集群實例的Shard節(jié)點或ConfigServer節(jié)點申請內(nèi)網(wǎng)連接地址。

標(biāo)簽管理

API 描述
TagResources 調(diào)用TagResources接口為一個或多個MongoDB實例綁定標(biāo)簽。
ListTagResources 調(diào)用ListTagResources接口查詢MongoDB實例和標(biāo)簽的綁定關(guān)系。
DescribeTags 調(diào)用DescribeTags接口查詢目標(biāo)地域中所有的標(biāo)簽信息。
UntagResources 調(diào)用UntagResources接口將標(biāo)簽從實例中解綁，如果該標(biāo)簽沒有綁定到其他實例，則該標(biāo)簽會被刪除。

賬號管理

API 描述
DescribeAccounts 調(diào)用DescribeAccounts接口查詢MongoDB實例的數(shù)據(jù)庫賬號信息。
ResetAccountPassword 調(diào)用ResetAccountPassword接口重置MongoDB實例中root賬號的密碼。
ModifyAccountDescription 調(diào)用ModifyAccountDescription接口修改MongoDB實例中root賬號的備注信息。

白名單和安全組

API 描述
DescribeSecurityGroupConfiguration 調(diào)用DescribeSecurityGroupConfiguration接口查詢MongoDB實例綁定的ECS安全組信息。
ModifySecurityGroupConfiguration 調(diào)用ModifySecurityGroupConfiguration接口更改MongoDB實例已綁定的ECS安全組。
DescribeSecurityIps 調(diào)用DescribeSecurityIps接口查詢MongoDB實例的IP白名單。
ModifySecurityIps 調(diào)用ModifySecurityIps接口修改MongoDB實例的IP白名單。

密鑰

API 描述
CheckCloudResourceAuthorized 調(diào)用CheckCloudResourceAuthorized接口查詢KMS密鑰是否已授權(quán)給MongoDB實例。
DescribeUserEncryptionKeyList 調(diào)用DescribeUserEncryptionKeyList接口查詢實例的自定義密鑰列表。
DescribeDBInstanceEncryptionKey 調(diào)用DescribeDBInstanceEncryptionKey接口查詢MongoDB實例的某個密鑰的詳情。
DescribeDBInstanceTDEInfo 調(diào)用DescribeDBInstanceTDEInfo接口查詢MongoDB實例的透明數(shù)據(jù)加密TDE（Transparent Data Encryption）是否開啟。
ModifyDBInstanceTDE 調(diào)用ModifyDBInstanceTDE接口修改MongoDB實例的透明數(shù)據(jù)加密TDE（Transparent Data Encryption）狀態(tài)。

SSL加密

API 描述
ModifyDBInstanceSSL 調(diào)用ModifyDBInstanceSSL接口修改MongoDB實例的SSL配置。
DescribeDBInstanceSSL 調(diào)用DescribeDBInstanceSSL接口查詢MongoDB實例的SSL設(shè)置詳情。

審計日志

API 描述
DescribeAuditRecords 調(diào)用DescribeAuditRecords接口查詢MongoDB實例的審計日志。
DescribeAuditPolicy 調(diào)用DescribeAuditPolicy接口查詢MongoDB實例的審計日志是否開啟。
ModifyAuditLogFilter 調(diào)用ModifyAuditLogFilter接口修改MongoDB實例審計日志的采集類型。
DescribeAuditLogFilter 調(diào)用DescribeAuditLogFilter接口查詢MongoDB實例審計日志采集的日志類型。
ModifyAuditPolicy 調(diào)用ModifyAuditPolicy接口設(shè)置MongoDB實例的審計日志開關(guān)或日志存儲時長。
DescribeMongoDBLogConfig 調(diào)用DescribeMongoDBLogConfig接口查看MongoDB審計日志的配置。

日志管理

API 描述
DescribeSlowLogRecords 調(diào)用DescribeSlowLogRecords接口查詢MongoDB實例運行出現(xiàn)的慢操作日志明細。
DescribeErrorLogRecords 調(diào)用DescribeErrorLogRecords接口查詢MongoDB實例的錯誤日志。
DescribeRunningLogRecords 調(diào)用DescribeRunningLogRecords接口查詢MongoDB實例的運行日志。

性能監(jiān)控管理

API 描述
DescribeDBInstancePerformance 調(diào)用DescribeDBInstancePerformance接口查詢MongoDB實例性能數(shù)據(jù)。
ModifyDBInstanceMonitor 調(diào)用ModifyDBInstanceMonitor接口設(shè)置MongoDB實例的監(jiān)控采集粒度。
DescribeDBInstanceMonitor 調(diào)用DescribeDBInstanceMonitor接口查詢MongoDB實例的監(jiān)控采集粒度。

參數(shù)管理

API 描述
DescribeParameterModificationHistory 調(diào)用DescribeParameterModificationHistory接口查詢MongoDB實例參數(shù)的修改記錄。
DescribeParameters 調(diào)用DescribeParameters接口查詢MongoDB實例的參數(shù)配置信息。
DescribeParameterTemplates 調(diào)用DescribeParameterTemplates接口查詢MongoDB實例默認的參數(shù)模板列表。
ModifyParameters 調(diào)用ModifyParameters接口修改MongoDB實例的參數(shù)。

備份與恢復(fù)

API 描述
DescribeBackupPolicy 調(diào)用DescribeBackupPolicy接口查詢MongoDB實例的備份策略。
ModifyBackupPolicy 調(diào)用ModifyBackupPolicy接口修改MongoDB實例的備份策略。
CreateBackup 調(diào)用CreateBackup接口手動備份MongoDB實例。
DescribeBackups 調(diào)用DescribeBackups接口查詢MongoDB實例的備份列表。
RestoreDBInstance 調(diào)用RestoreDBInstance接口恢復(fù)數(shù)據(jù)至當(dāng)前MongoDB實例。
DescribeBackupDBs 調(diào)用DescribeBackupDBs接口用于執(zhí)行單庫恢復(fù)前，查詢指定的時間點或備份集內(nèi)包含的數(shù)據(jù)庫。
CheckRecoveryCondition 調(diào)用CheckRecoveryCondition接口檢查MongoDB實例是否滿足數(shù)據(jù)恢復(fù)的條件。

續(xù)費管理

API 描述
DescribePrice 調(diào)用DescribePrice接口查詢創(chuàng)建MongoDB實例、升級配置或續(xù)費操作產(chǎn)生的費用。
ModifyInstanceAutoRenewalAttribute 調(diào)用ModifyInstanceAutoRenewalAttribute接口設(shè)置MongoDB實例的自動續(xù)費功能。
TransformToPrePaid 調(diào)用TransformToPrePaid接口將按量付費的MongoDB實例轉(zhuǎn)換為包年包月（預(yù)付費）實例。
RenewDBInstance 調(diào)用RenewDBInstance接口手動續(xù)費包年包月的MongoDB實例。
DescribeRenewalPrice 調(diào)用DescribeRenewalPrice接口查詢指定MongoDB實例續(xù)費一個月的價格。

附表