API 概覽 - ApsaraDB for MongoDB

API標準及多語言預置SDK

本產品（Dds/2015-12-01）的OpenAPI採用RPC簽名風格。我們已經為開發人員封裝了常見程式設計語言的SDK，開發人員可通過下載SDK直接調用本產品OpenAPI而無需關心技術細節。如果現有SDK不能滿足使用需求，可通過簽名機制進行自簽名對接。由於自簽名細節非常複雜，需花費 5個工作日左右。因此建議加入我們的服務DingTalk群（147535001692），在專家指導下進行簽名對接。

在使用API前，您需要準備好身份帳號及存取金鑰（AccessKey），才能有效通過用戶端工具（SDK、CLI等）訪問API。細節請參見擷取AccessKey。

自訂簽名情境

若您的業務情境有特殊需求，需通過自簽名方式對接 API，建議優先諮詢我們的支援人員團隊（服務DingTalk群：147535001692），擷取專業指導以確保高效接入。

帳號與安全準備

阿里雲帳號具備對所有資源的完全系統管理權限。一旦 AccessKey 泄露，所有相關資源都將面臨未經授權訪問的風險。為確保安全，建議建立一個僅具備 API 存取權限的RAM使用者並配置其 AccessKey，同時基於最小許可權原則 (PoLP) 配置 RAM 策略。僅在明確需要阿里雲帳號許可權的特定情境下，才使用阿里雲帳號。

建立或複製執行個體

API	標題	API概述
CreateDBInstance	建立或複製複本集執行個體	建立或複製ApsaraDB for MongoDB複本集執行個體。
CreateShardingDBInstance	建立或複製分區叢集執行個體	建立或者複製 MongoDB 分區叢集執行個體。

變更執行個體設定

API	標題	API概述
CreateNode	新增Shard節點或Mongos節點	為ApsaraDB for MongoDB分區叢集執行個體添加Shard節點或Mongos節點。
CreateNodeBatch	大量建立節點	為ApsaraDB for MongoDB分區叢集執行個體大量新增Mongos節點、Shard節點。
DeleteNode	刪除分區叢集執行個體中的節點	刪除MongoDB分區叢集執行個體中的Shard節點或Mongos節點。
ModifyDBInstanceSpec	變更單節點或複本集執行個體的規格或儲存空間	變更ApsaraDB for MongoDB單節點執行個體、複本集執行個體和Serverless執行個體（僅中國站支援Serverless執行個體）的規格或儲存空間。
ModifyNodeSpec	變更分區叢集執行個體中節點的規格和儲存空間	變更MongoDB分區叢集執行個體中節點的規格和儲存空間。
ModifyNodeSpecBatch	批量修改節點規格	變更ApsaraDB for MongoDB分區叢集執行個體中一個或多個Mongos節點、Shard節點的配置。
ModifyDBInstanceDiskType	修改執行個體磁碟類型	修改ApsaraDB for 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	轉換ApsaraDB for MongoDB執行個體的付費類型	轉換ApsaraDB for MongoDB執行個體的付費類型，將隨用隨付（後付費）執行個體轉換為訂用帳戶（預付費）執行個體或者訂用帳戶執行個體轉換為隨用隨付執行個體。
DescribePrice	查詢費用	詢價。
DescribeRenewalPrice	查詢執行個體續約一個月的價格	查詢指定MongoDB執行個體續約一個月的價格。
TransformToPrePaid	將隨用隨付執行個體轉換為訂用帳戶執行個體	將隨用隨付的MongoDB執行個體轉換為訂用帳戶（預付費）執行個體。
RenewDBInstance	手動續約訂用帳戶的執行個體	手動續約訂用帳戶的MongoDB執行個體。

查詢執行個體

API	標題	API概述
DescribeDBInstanceSpecInfo	查詢執行個體規格的詳細資料	查看執行個體規格資訊詳情
DescribeReplicaSetRole	查詢執行個體中的角色資訊及串連資訊	查詢MongoDB執行個體中的角色資訊及串連資訊。
DescribeKernelReleaseNotes	查詢執行個體的小版本發布日誌	查詢MongoDB執行個體的小版本發布日誌。
DescribeAvailableEngineVersion	查詢執行個體可升級的版本	查詢MongoDB執行個體可升級的版本。
DescribeDBInstances	查詢MongoDB執行個體列表	查詢MongoDB執行個體列表。
DescribeDBInstanceSwitchLog	查詢執行個體的主備切換日誌資訊	查詢執行個體的主備切換日誌。
DescribeDBInstanceAttribute	查詢ApsaraDB for MongoDB執行個體的資訊	查詢ApsaraDB for MongoDB 執行個體的資訊。
DescribeRoleZoneInfo	查詢執行個體的各節點的角色和所屬的可用性區域	查詢MongoDB執行個體的各節點的角色和所屬的可用性區域。
DescribeInstanceAutoRenewalAttribute	查詢MongoDB執行個體是否為自動付費	查詢MongoDB執行個體是否為自動付費。
DescribeActiveOperationTaskCount	查詢MongoDB執行個體的營運任務數量	查詢MongoDB執行個體的營運任務數量。
DescribeActiveOperationTasks	查詢多個主動營運任務資訊	查詢MongoDB執行個體的計劃內營運任務詳情。
DescribeActiveOperationTaskType	查詢營運任務類型和任務數量	查詢執行個體的營運任務類型以及各類型的任務數量。
DescribeDBInstancesOverview	查詢執行個體的概覽資訊	查詢一個或多個ApsaraDB for MongoDB執行個體的概覽資訊。
DescribeHistoryTasks	查詢工作中樞的任務資訊	查看工作中樞的工作清單。
DescribeHistoryTasksStat	查詢工作中樞任務狀態的概覽資訊	查看工作中樞任務的概覽資訊。
ModifyTaskInfo	工作中樞修改任務資訊	任務操作，修改工作中樞的任務資訊。
ModifyActiveOperationTasks	修改多個主動營運任務切換時間	該介面用於修改ApsaraDB for 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	為雲資料庫分區叢集執行個體節點申請內網串連地址	為ApsaraDB for 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白名單模板	修改ApsaraDB for 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	查看Log Service的配置	查看MongoDBLog Service的配置。

日誌管理

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	切換至叢集備份模式	將ApsaraDB for MongoDB分區叢集執行個體的備份模式切換為叢集備份模式。切換至叢集備份模式後，執行個體將支援高頻備份。
DescribeClusterBackups	查詢叢集備份組列表	查詢ApsaraDB for MongoDB雲端硬碟版分區叢集的叢集備份組列表。
DescribeClusterRecoverTime	查詢分片叢集可恢復時間段	查詢雲端資料庫 MongoDB 版雲端硬碟版分片叢集執行個體的可恢復時間。
DescribeBackupStorage	查詢執行個體的備份使用量	查詢MongoDB雲端硬碟版複本集或分區叢集的備份使用量。
DescribeBackupTasks	查詢執行個體進行中的備份任務	查詢MongoDB雲端硬碟版複本集或分區集進行中的備份任務
DescribeInstanceRecoverTime	查詢副本集執行個體的可恢復時間	查詢雲端資料庫 MongoDB 版雲端硬碟版副本集執行個體的可恢復時間。

其他

API	標題	API概述
DescribeActiveOperationTask	查詢營運任務詳情	查詢營運任務詳情。
AllocateDBInstanceSrvNetworkAddress	申請Srv地址	為ApsaraDB for MongoDB執行個體申請 Srv 地址
DescribeActiveOperationTaskRegion	查詢營運任務類型和任務數量	查詢MongoDB執行個體的營運任務類型和任務數量。
DescribeActiveOperationMaintenanceConfig	查詢執行個體的營運任務配置	查詢MongoDB執行個體的營運任務配置。
CheckServiceLinkedRole	查詢是否已建立服務關聯角色	查看是否已建立服務關聯角色（SLR）。
ModifyDBInstanceConfig	修改執行個體的屬性配置	修改執行個體配置
ModifyDBInstanceAttribute	修改執行個體部分資訊	調用該介面，可以設定執行個體釋放保護配置。
ModifySrvNetworkAddress	修改MongoDB執行個體的SRV串連地址	修改MongoDB執行個體的SRV串連地址
CancelActiveOperationTasks	取消營運事件	批量取消營運事件。
CreateNodeRoleTag	建立節點角色標籤	建立執行個體節點角色標籤。
DescribeRdsVSwitchs	擷取虛擬交換器列表	擷取虛擬交換器（vSwitch）列表。
DescribeRdsVpcs	擷取VPC列表	擷取VPC列表。
DescribeRoleTagStatus	查詢節點Tag是否已建立	查詢節點Tag是否已建立
DescribeVpcsForMongoDB	分頁擷取VPC列表	分頁擷取VPC列表。
ModifyActiveOperationMaintenanceConfig	修改執行個體的營運任務配置	修改mongoDb執行個體的營運任務配置
DescribeBinlogFiles	查詢執行個體的記錄備份檔案	查詢ApsaraDB for MongoDB執行個體的記錄備份檔案
ModifyBackupExpireTime	修改MongoDB備份組的到期時間	修改MongoDB備份組的到期時間
DeleteBackup	刪除MongoDB備份組	刪除MongoDB備份組