全部產品
Search

搜尋本產品

    ：API概覽

    文件中心

    ：API概覽

    更新時間：Jun 19, 2024

    本文介紹ApsaraDB for MongoDB提供的API介面。

    建立或複製執行個體

    API描述
    CreateDBInstance調用CreateDBInstance介面建立或複製MongoDB複本集執行個體。
    CreateShardingDBInstance調用CreateShardingDBInstance介面建立或複製MongoDB分區叢集執行個體。

    變更執行個體配置

    API描述
    ModifyDBInstanceSpec調用ModifyDBInstanceSpec介面變更MongoDB單節點執行個體或複本集執行個體的規格或儲存空間。
    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執行個體列表。
    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執行個體的審計日誌開關或日誌儲存時間長度。
    DescribeMongoDBLogConfig調用DescribeMongoDBLogConfig介面查看MongoDB審計日誌的配置。

    日誌管理

    API描述
    DescribeSlowLogRecords調用DescribeSlowLogRecords介面查詢MongoDB執行個體運行出現的慢動作記錄明細。
    DescribeErrorLogRecords調用DescribeErrorLogRecords介面查詢MongoDB執行個體的錯誤記錄檔。
    DescribeRunningLogRecords調用DescribeRunningLogRecords介面查詢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描述
    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執行個體續約一個月的價格。

    附表