DescribeBackups - 查看備份組列表 - Tair (Redis® OSS-Compatible)

查詢雲資料庫 Tair（相容 Redis）執行個體的備份檔案資訊。

介面說明

本介面不適用雲原生版叢集架構執行個體，如有需要請使用 DescribeClusterBackupList 介面。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

kvstore:DescribeBackups

get

*DBInstance

acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}

無

請求參數

名稱	類型	必填	描述	樣本值
InstanceId	string	是	執行個體 ID。	r-bp1zxszhcgatnx****
BackupId	integer	否	備份檔案的 ID。	11611111
BackupJobId	integer	否	備份任務 ID，由 CreateBackup 返回，CreateBackup 若返回多個 BackupJobId，則需要使用本介面分別對其查詢。	10001
PageSize	integer	否	每頁最大記錄數，取值：30、50、100、200 或 300。	30
PageNumber	integer	否	頁碼，取值大於 0 且不超過整數資料類型的最大值，預設值為 1。	1
StartTime	string	是	查詢開始時間，格式為yyyy-MM-ddTHH:mmZ（UTC 時間）。	2019-03-11T10:00Z
EndTime	string	是	查詢結束時間，必須晚於查詢開始時間，格式為yyyy-MM-ddTHH:mmZ（UTC 時間）。	2019-03-14T18:00Z
NeedAof	string	否	是否開啟 AoF 落盤，取值： 0：關閉。 1：開啟。說明預設值：0。	1

返回參數

名稱	類型	描述	樣本值
	object
RequestId	string	請求 ID。	963C20F0-7CE1-4591-AAF3-6F3CD1CE****
PageNumber	integer	頁碼。	1
PageSize	integer	每頁最大記錄數。	30
TotalCount	integer	備份總個數。	5
FullStorageSize	integer	當前執行個體全量備份檔案的大小，單位是位元組。全量備份來源於每天定時備份、手動備份、緩衝分析時產生的備份等。說明該值和當前請求所響應的備份組數量以及大小無關，而是該執行個體當前所有有效全量備份的大小。	1000
LogStorageSize	integer	當前執行個體記錄備份檔案的大小，單位是位元組，若且唯若開啟閃回時才有效。說明該值和當前請求所響應的備份組數量以及大小無關，而是該執行個體當前所有有效記錄備份的大小。	5000
FreeSize	integer	該參數未生效，請忽略該參數。	100000
Backups	object
Backup	array<object>	備份組詳情。
	object	備份組詳情。
BackupStatus	string	備份狀態，傳回值： Success：成功。 Failed：失敗。	Success
BackupStartTime	string	備份開始時間。	2019-03-14T05:28:50Z
BackupType	string	備份類型，傳回值： FullBackup：全量備份。 IncrementalBackup：增量備份。	FullBackup
BackupDownloadURL	string	備份檔案的外網下載地址。	https://rdsbak-hk45-v2.oss-cn-hongkong.aliyuncs.com/********
NodeInstanceId	string	節點 ID。說明當執行個體的架構為標準版時，本參數返回的是執行個體 ID。	r-bp10noxlhcoim2****-db-1
BackupEndTime	string	備份結束時間。	2019-03-14T05:31:13Z
BackupId	integer	備份檔案 ID。	165*****50
BackupDBNames	string	備份的資料庫，預設為 all，即備份所有資料庫。	all
EngineVersion	string	引擎版本，即執行個體相容 Redis 的版本。	4.0
BackupIntranetDownloadURL	string	備份檔案的內網下載地址。說明您可以在與該執行個體連通的 ECS（二者需屬於同一 VPC 內）上使用該地址下載目標備份檔案。	https://rdsbak-hk45-v2.oss-cn-hongkong.aliyuncs.com/********
BackupSize	integer	備份檔案大小。	1024
BackupMode	string	備份模式，傳回值： Automated：自動備份。 Manual：手動備份。	Automated
BackupMethod	string	備份方法，傳回值： Logical：邏輯備份。 Physical：物理備份。	Physical
BackupJobID	integer	備份任務 ID。	24340
RecoverConfigMode	string	備份組中是否包含了帳號（account）、核心參數（whitelist）、白名單（config）資訊。說明本參數僅適用於雲原生版執行個體。若您修改執行個體的上述資訊（例如建立了一個帳號或添加了一個白名單），在後續的備份組中會自動備份上述資訊。	{"whitelist":true,"config":true,"account":true}
ExpectExpireTime	string	備份組到期時間，格式為yyyy-MM-ddTHH:mmZ（UTC 時間）。	2025-06-01T21:51:22Z
AccessDeniedDetail	object	本組參數已棄用，請忽略。
AuthAction	string	說明如上。	-
AuthPrincipalDisplayName	string	說明如上。	-
AuthPrincipalOwnerId	string	說明如上。	-
AuthPrincipalType	string	說明如上。	-
EncodedDiagnosticMessage	string	說明如上。	-
NoPermissionType	string	說明如上。	-
PolicyType	string	說明如上。	-

樣本

正常返回樣本

JSON格式

{
  "RequestId": "963C20F0-7CE1-4591-AAF3-6F3CD1CE****",
  "PageNumber": 1,
  "PageSize": 30,
  "TotalCount": 5,
  "FullStorageSize": 1000,
  "LogStorageSize": 5000,
  "FreeSize": 100000,
  "Backups": {
    "Backup": [
      {
        "BackupStatus": "Success",
        "BackupStartTime": "2019-03-14T05:28:50Z",
        "BackupType": "FullBackup",
        "BackupDownloadURL": "https://rdsbak-hk45-v2.oss-cn-hongkong.aliyuncs.com/********",
        "NodeInstanceId": "r-bp10noxlhcoim2****-db-1",
        "BackupEndTime": "2019-03-14T05:31:13Z",
        "BackupId": 0,
        "BackupDBNames": "all",
        "EngineVersion": "4.0",
        "BackupIntranetDownloadURL": "https://rdsbak-hk45-v2.oss-cn-hongkong.aliyuncs.com/********",
        "BackupSize": 1024,
        "BackupMode": "Automated",
        "BackupMethod": "Physical",
        "BackupJobID": 24340,
        "RecoverConfigMode": "{\"whitelist\":true,\"config\":true,\"account\":true}",
        "ExpectExpireTime": "2025-06-01T21:51:22Z"
      }
    ]
  },
  "AccessDeniedDetail": {
    "AuthAction": "-",
    "AuthPrincipalDisplayName": "-",
    "AuthPrincipalOwnerId": "-",
    "AuthPrincipalType": "-",
    "EncodedDiagnosticMessage": "-",
    "NoPermissionType": "-",
    "PolicyType": "-"
  }
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
400	InvalidStartTime.Malformed	The Specified parameter StartTime is not valid.
400	InvalidEndTime.Malformed	The Specified parameter EndTime is not valid.
400	InvalidEngineVersion.Malformed	The Specified EngieVersion is not valid.
400	InvalidStartTimeAndEndTime.Malformed	The end time must be greater than the start time.	結束時間必須大於開始時間
400	InvalidPageSize.Malformed	The specified parameter PageSize is not valid.

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

變更歷史

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