全部產品
Search

搜尋本產品

    ApsaraDB for MongoDB：DescribeBackupDBs - 查詢指定的時間點或備份組內自主資料庫

    文件中心

    ApsaraDB for MongoDB：DescribeBackupDBs - 查詢指定的時間點或備份組內自主資料庫

    更新時間：Apr 21, 2026

    在為MongoDB執行個體執行單庫恢複前，您可以調用本介面查詢指定的時間點或備份組內自主資料庫。

    介面說明

    您可以調用 CreateDBInstance 介面進行單庫恢複。更多資訊，請參見 MongoDB 單庫恢複。

    調用本介面時，執行個體必須滿足以下條件：

    • 執行個體的建立時間晚於 2019 年 3 月 26 日。

    • 執行個體屬於華北 1、華北 2、華北 3、華北 5、華東 1、華東 2、華南 1 或亞太地區東南 1（新加坡）地區。

    • 執行個體類型為複本集執行個體。

    • 執行個體版本須為 3.4、4.0、4.2 本地碟版本。

    • 執行個體儲存引擎必須為 WiredTiger。

    調試

    您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

    調試

    授權資訊

    下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

    • 操作：是指具體的許可權點。

    • 存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。

    • 資源類型：是指操作中支援授權的資源類型。具體說明如下：

      • 對於必選的資源類型，用前面加 * 表示。

      • 對於不支援資源級授權的操作，用全部資源表示。

    • 條件關鍵字：是指雲產品自身定義的條件關鍵字。

    • 關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    dds:DescribeBackupDBs

    get

    *Instance

    acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}

    		 無 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    PageNumber

    integer

    否

    頁碼，取值為大於 0 且不超過 整數資料類型的最大值，預設值為 1。

    1
    PageSize

    integer

    否

    每頁可展示的記錄數。取值： 30（預設值）、50、100。

    30
    SourceDBInstance

    string

    是

    待恢複資料的源執行個體 ID。

    dds-bp2286****
    RestoreTime

    string

    否

    執行個體所需恢複的時間點，格式為 yyyy-MM-ddTHH:mm:ssZ（UTC 時間）。

    說明

    • 本參數可取值為 7 天內的任意時間，但是須早於目前時間，且晚於執行個體的建立時間。

    • 本參數和 BackupId 參數兩者中必須傳入一項。

    2019-08-22T12:00:00Z
    BackupId

    string

    否

    備份 ID。

    說明

    • 您可以通過調用 DescribeBackups 介面查詢備份 ID。

    • 本參數和 RestoreTime 參數兩者中必須傳入一項。

    5664****
    ResourceGroupId

    string

    否

    資源群組 ID。

    rg-ax68****
    SourceDBInstance

    string

    是

    待恢複資料的源執行個體 ID。

    dds-bp2286****

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    TotalCount

    integer

    查詢結果中資料庫的數量。

    5
    Databases

    object

    Database

    array<object>

    資料庫列表。

    object

    DBName

    string

    資料庫名。

    mongodbtest
    RequestId

    string

    請求 ID。

    1AF0AD89-ED4F-44AD-B65F-BFC1D5CD9455
    PageSize

    integer

    每頁可展示的記錄數。

    30
    PageNumber

    integer

    頁碼。

    1

    樣本

    正常返回樣本

    JSON格式

    {
  "TotalCount": 5,
  "Databases": {
    "Database": [
      {
        "DBName": "mongodbtest"
      }
    ]
  },
  "RequestId": "1AF0AD89-ED4F-44AD-B65F-BFC1D5CD9455",
  "PageSize": 30,
  "PageNumber": 1
}

    錯誤碼

    HTTP status code

    錯誤碼

    錯誤資訊

    描述
    400 InvalidMeta.WrongFormat Meta information is wrong formatter.
    400 InvalidRestoreTime.Format Specified restore time is not valid. 指定的參數RestoreTime不合法，請您檢查輸入的參數是否正確。
    403 InvalidDBName The specified database name is not allowed. 指定的資料庫名稱無效
    403 InvalidMeta.TooLarge Meta information is too large. 元資訊太大。
    403 SingleDBRestore.BackupSetNotSupport This backup set do not support this operation. 所選擇的時間點或備份檔案尚未支援單庫恢複功能。
    403 IncorrectDBInstanceType Current DB instance type does not support this operation.
    403 IncorrectEngineVersion Current engine version does not support operations.
    403 InvalidBackupLogStatus Current backup log enable status does not support this operation. 當前備份日誌啟用狀態不支援此操作。
    403 IncorrectBackupSetState Current backup set state does not support operations..
    404 InvalidBackupSetID.NotFound Specifiedbackup set ID does not exist.
    404 InvalidBackup.NotFound Theavailable backup does not exist in recovery time. 恢復內不存在可用的備份。

    訪問錯誤中心查看更多錯誤碼。

    變更歷史

    更多資訊，參考變更詳情。