DescribeBackups - 查詢執行個體的備份列表 -

查詢MongoDB執行個體的備份列表。

調試

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

調試

授權資訊

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

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

dds:DescribeBackups

get

*Instance

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

無

請求參數

名稱	類型	必填	描述	樣本值
DBInstanceId	string	是	執行個體 ID。說明當本參數傳入的是分區叢集執行個體 ID 時，還需要傳入 NodeId 參數。	dds-bp1a7009eb24****
NodeId	string	否	分區叢集執行個體中 Shard 節點的 ID。說明當 DBInstanceId 參數傳入的是分區叢集執行個體 ID 時，本參數必填。	d-bp128a003436****
BackupId	string	否	備份 ID。當 DBInstanceId 參數傳入的是分區叢集執行個體 ID 時，備份 ID 個數與 Shard 節點個數相同，中間用英文逗號（,）間隔。	2072**,2072,2072**
PageNumber	integer	否	頁碼，取值為大於 0 且不超過整數資料類型的最大值，預設值為 1。	1
PageSize	integer	否	每頁記錄數，取值： 30（預設值） 50 100	30
StartTime	string	否	查詢開始時間，格式為yyyy-MM-ddTHH:mmZ（UTC 時間）。說明當傳入 BackupId 時，此參數無效。	2022-01-13T13:00Z
EndTime	string	否	查詢結束時間，必須晚於查詢開始時間，格式為yyyy-MM-ddTHH:mmZ（UTC 時間）。說明當傳入 BackupId 時，此參數無效。	2022-01-14T13:00Z
SrcRegion	string	否	執行個體所在地區。說明已刪除執行個體恢複必填。異地備份必填。	cn-beijing
DestRegion	string	否	備份所在地區。說明異地備份必填。	cn-hangzhou
ResourceGroupId	string	否	資源群組 ID。	rg-xxxx
BackupJobId	string	否	備份任務 ID。	775051

返回參數

名稱	類型	描述	樣本值
	object	執行個體備份資訊。
TotalCount	integer	備份總數。	1
RequestId	string	請求 ID。	275D43C3-F12F-5224-B375-************
PageSize	integer	每頁記錄數，取值： 30（預設值） 50 100	30
PageNumber	integer	頁碼。	1
Backups	object
Backup	array<object>	備份檔案詳情列表。
	object	備份檔案詳情列表。
BackupStatus	string	備份狀態，取值說明： Success：備份成功。 Failed：備份失敗。	Success
BackupType	string	備份類型，取值說明： FullBackup：全量備份。 IncrementalBackup：增量備份。	FullBackup
BackupStartTime	string	本次備份開始時間，格式為yyyy-MM-ddTHH:mm:ssZ（UTC 時間）。	2022-01-14T03:56:17Z
BackupIntranetDownloadURL	string	備份檔案的內網下載地址。說明您可以通過該地址在 ECS 伺服器（與ApsaraDB for MongoDB 執行個體在同一網路）上下載目標備份檔案。	http://rdsbak-hz-v3.oss-cn-hangzhou-internal.aliyuncs.com/custins5559***/hins1936_data_2022052504_qp.xb?Expires=165361&OSSAccessKeyId=*******************&Signature=****************************&Region=cn-hangzhou
BackupSize	integer	備份檔案大小，單位：Byte。	6168576
BackupDownloadURL	string	備份檔案的外網下載地址，若當前不可下載，則返回為空白字串。	http://rdsbak-hz-v3.oss-cn-hangzhou.aliyuncs.com/custins5559**/hins1936_data_2022052504_qp.xb?Expires=165361&OSSAccessKeyId=********************&Signature=****************************&Region=cn-hangzhou
BackupMode	string	備份模式，取值說明： Automated：系統自動備份。 Manual：手動備份。	Automated
BackupEndTime	string	本次備份結束時間，格式為yyyy-MM-ddTHH:mm:ssZ（UTC 時間）。	2022-01-14T03:57:34Z
BackupId	string	備份 ID。	32102****
BackupDBNames	string	備份的資料庫名。	database
BackupMethod	string	備份方式，取值說明： Snapshot：快照備份。 Physical：物理備份。 Logical：邏輯備份。	Physical
BackupJobId	string	備份組任務 ID。	1123xxxx
BackupName	string	備份組名稱(當前無效)。	12345678.tar.gz
BackupScale	string	備份粒度(當前無效)。	DBInstance
IsAvail	boolean	備份組是否可用，取值說明： 0：不可用。 1：可用。	1
EngineVersion	string	備份時的執行個體版本號碼，取值： 7.0 6.0 5.0 4.4 4.2 4.0 3.4	4.2
BackupExpireTime	string	備份到期時間，格式為yyyy-MM-ddTHH:mm:ssZ（UTC 時間）。重要 "9999-01-01T00:00:00Z"表示長期保留。	2025-08-30T09:49:11Z

樣本

正常返回樣本

JSON格式

{
  "TotalCount": 1,
  "RequestId": "275D43C3-F12F-5224-B375-************",
  "PageSize": 30,
  "PageNumber": 1,
  "Backups": {
    "Backup": [
      {
        "BackupStatus": "Success",
        "BackupType": "FullBackup",
        "BackupStartTime": "2022-01-14T03:56:17Z",
        "BackupIntranetDownloadURL": "http://rdsbak-hz-v3.oss-cn-hangzhou-internal.aliyuncs.com/custins5559*****/hins1936****_data_2022052504****_qp.xb?Expires=165361****&OSSAccessKeyId=***********************&Signature=******************************&Region=cn-hangzhou",
        "BackupSize": 6168576,
        "BackupDownloadURL": "http://rdsbak-hz-v3.oss-cn-hangzhou.aliyuncs.com/custins5559****/hins1936****_data_2022052504****_qp.xb?Expires=165361****&OSSAccessKeyId=************************&Signature=******************************&Region=cn-hangzhou",
        "BackupMode": "Automated",
        "BackupEndTime": "2022-01-14T03:57:34Z",
        "BackupId": "32102****",
        "BackupDBNames": "database",
        "BackupMethod": "Physical",
        "BackupJobId": "1123xxxx",
        "BackupName": "12345678.tar.gz",
        "BackupScale": "DBInstance",
        "IsAvail": true,
        "EngineVersion": "4.2",
        "BackupExpireTime": "2025-08-30T09:49:11Z"
      }
    ]
  }
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊
400	InvalidStartTime.Malformed	The Specified parameter StartTime is not valid.
400	InvalidEndTime.Malformed	The Specified parameter EndTime is not valid.
400	InvalidStartTimeAndEndTime.Malformed	The Specified parameter StartTime or EndTime is not valid.
400	InvalidPageSize.Malformed	The specified parameter PageSize is not valid.

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

變更歷史

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