全部產品
Search
文件中心

ApsaraDB for MongoDB:DescribeRestoreDBInstanceList - 查詢MongoDB執行個體的備份恢複執行個體

更新時間:Apr 21, 2026

查詢MongoDB執行個體7天以內的備份恢複執行個體列表。

調試

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

調試

授權資訊

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

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

  • 存取層級:是指每個操作的存取層級,取值為寫入(Write)、讀取(Read)或列出(List)。

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

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

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

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

dds:DescribeRestoreDBInstanceList

get

*Instance

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

請求參數

名稱

類型

必填

描述

樣本值

PageNumber

integer

頁碼。

1

PageSize

integer

每頁記錄數。

30

DBInstanceId

string

執行個體 ID。

dds-bp114f14849d****

CreationTimeAfter

string

尋找執行個體建立時間在該時間以後的執行個體,格式為yyyy-MM-ddTHH:00:00Z(UTC 時間)。

說明
  • 時間為整點時間

  • 時間不能早於目前時間-7 天。

2024-07-24T14:00:00Z

返回參數

名稱

類型

描述

樣本值

object

TotalCount

integer

查詢結果中執行個體的數量。

5

RequestId

string

請求 ID。

1AF0AD89-ED4F-44AD-B65F-BFC1D5Cxxxxx

PageSize

integer

每頁記錄數。

30

PageNumber

integer

頁碼。

1

DBInstances

object

DBInstance

array<object>

執行個體資訊列表。

object

執行個體資訊列表。

CreationTime

string

執行個體建立的時間,格式為yyyy-MM-ddTHH:mm:ssZ(UTC 時間)。

2022-01-02T07:43:59Z

LockMode

string

執行個體的鎖定狀態,取值說明:

  • Unlock:正常。

  • ManualLock:手動觸發鎖定。

  • LockByExpiration:執行個體到期自動鎖定。

  • LockByRestoration:執行個體復原前自動鎖定。

  • LockByDiskQuota:執行個體空間滿自動鎖定。

Unlock

EngineVersion

string

資料庫版本號碼,取值:

  • 7.0

  • 6.0

  • 5.0

  • 4.4

  • 4.2

  • 4.0

4.2

DBInstanceDescription

string

執行個體的描述或備忘資訊。

測試資料庫

DBInstanceType

string

執行個體類型,取值說明:

  • sharding:分區叢集執行個體。

  • replicate:複本集執行個體。

replicate

DBInstanceStatus

string

執行個體狀態,詳情請參見執行個體狀態表

Running

RegionId

string

執行個體所屬地區 ID。

cn-hangzhou

ZoneId

string

執行個體所屬可用性區域 ID。

cn-hangzhou-g

DBInstanceId

string

執行個體 ID。

dds-bp12c5b040dc****

SecondaryZoneId

string

實現多可用性區域部署時,執行個體的備可用性區域 1。

cn-hangzhou-i

HiddenZoneId

string

實現多可用性區域部署時,執行個體的備可用性區域 2。

cn-hangzhou-h

IsDeleted

integer

是否被刪除:

  • 1:代表已被刪除。

  • 0:代表未被刪除。

0

樣本

正常返回樣本

JSON格式

{
  "TotalCount": 5,
  "RequestId": "1AF0AD89-ED4F-44AD-B65F-BFC1D5Cxxxxx",
  "PageSize": 30,
  "PageNumber": 1,
  "DBInstances": {
    "DBInstance": [
      {
        "CreationTime": "2022-01-02T07:43:59Z",
        "LockMode": "Unlock",
        "EngineVersion": "4.2",
        "DBInstanceDescription": "測試資料庫",
        "DBInstanceType": "replicate",
        "DBInstanceStatus": "Running",
        "RegionId": "cn-hangzhou",
        "ZoneId": "cn-hangzhou-g",
        "DBInstanceId": "dds-bp12c5b040dc****",
        "SecondaryZoneId": "cn-hangzhou-i",
        "HiddenZoneId": "cn-hangzhou-h",
        "IsDeleted": 0
      }
    ]
  }
}

錯誤碼

HTTP status code

錯誤碼

錯誤資訊

描述

400 InvalidParameter The specified parameter %s is not valid. 參數 %s 非有效參數。
400 InvalidDBInstanceId.NotFound Specified instance does not exist. 該執行個體不存在,原因可能是該執行個體已經釋放,請重新整理頁面。

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

變更歷史

更多資訊,參考變更詳情