DescribeBackups - 查看RDS執行個體備份組列表 - ApsaraDB RDS

該介面用於查看RDS執行個體的備份組列表。

介面說明

適用引擎

RDS MySQL
RDS PostgreSQL
RDS SQL Server
RDS MariaDB

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

rds:DescribeBackups

get

DBInstance

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

無

請求參數

名稱	類型	必填	描述	樣本值
DBInstanceId	string	是	執行個體 ID。可調用 DescribeDBInstances 擷取。	rm-uf6wjk5****
BackupId	string	否	備份組 ID。	327329803
BackupStatus	string	否	備份組狀態。取值： Success：已完成備份 Failed：備份失敗	Success
BackupMode	string	否	備份模式，取值： Automated：系統自動備份 Manual：手動備份	Automated
StartTime	string	否	查詢開始時間。格式：yyyy-MM-ddTHH:mmZ（UTC 時間）。	2011-06-01T16:00Z
EndTime	string	否	查詢結束時間，需要大於查詢開始時間。格式：yyyy-MM-ddTHH:mmZ（UTC 時間）。說明建議您在使用本介面查詢備份組列表資訊時，將查詢開始和結束的時間段縮小一些，如果時間段較長可能出現逾時問題。	2011-06-15T16:00Z
PageSize	integer	否	每頁記錄數，取值： 30 50 100 預設值：30。	30
PageNumber	integer	否	頁碼，取值：大於 0 且不超過 Integer 的最大值。預設值：1。	1
BackupType	string	否	備份類型，取值： FullBackup：全量備份 IncrementalBackup：增量備份	FullBackup

返回參數

名稱	類型	描述	樣本值
	object	返回參數詳情。
Items	object
Backup	array<object>	備份組列表。
	array<object>	備份組列表詳情。
BackupDownloadLinkByDB	object
BackupDownloadLinkByDB	array<object>	單庫備份下載連結清單。說明雲端硬碟執行個體不返回該參數。
	object	單庫備份下載連結詳情。
DataBase	string	資料庫名稱。	dbs
DownloadLink	string	下載連結地址。	https://cn-hangzhou.bak.rds.aliyuncs.com/custins53664665/hins18676859_2021072909473127987849.zip?Expires=****&dbList=tb1
IntranetDownloadLink	string	內網下載連結地址。	https://cn-hangzhou-internal.bak.rds.aliyuncs.com/custins53664665/hins18676859_2021072909473127987849.zip?Expires=****&dbList=tb1
BackupDownloadURL	string	公網下載地址，若當前不可下載，則返回空值。例如：備份方式為快照備份的 SQL Server 執行個體會返回空值。說明雲端硬碟執行個體不返回該參數。	http://rdsbak-hz-v3.oss-cn-hangzhou.aliyuncs.com/****
BackupEndTime	string	本次備份結束時間。格式：yyyy-MM-ddTHH:mmZ（UTC 時間）。	2019-02-13T12:20:00Z
BackupId	string	備份組 ID。	321020562
BackupInitiator	string	備份任務的發起者。傳回值： System：系統自動發起。 User：使用者手動發起。	System
BackupIntranetDownloadURL	string	內網下載地址，若當前不可下載，則返回空值。例如：備份方式為快照備份的 SQL Server 執行個體會返回空值。說明雲端硬碟執行個體不返回該參數。	http://rdsbak-hz-v3.oss-cn-hangzhou-internal.aliyuncs.com/****
BackupMethod	string	備份方式，傳回值： Logical：邏輯備份 Physical：物理備份 Snapshot：快照備份	Physical
BackupMode	string	備份模式，傳回值： Automated：系統自動備份 Manual：手動備份	Automated
BackupSize	integer	備份檔案大小，單位：Byte。	2167808
BackupStartTime	string	本次備份開始時間。格式：yyyy-MM-ddTHH:mmZ（UTC 時間）。	2019-02-03T12:20:00Z
BackupStatus	string	備份組狀態。	Success
BackupType	string	備份類型，傳回值： FullBackup：全量備份 IncrementalBackup：增量備份	FullBackup
Checksum	string	校正和，採用 CRC64 演算法。	1835830439****
ConsistentTime	integer	備份組的一致性時間點。傳回值為時間戳記。說明僅 MySQL 5.6 返回本參數，其他版本返回 0。	1576506856
CopyOnlyBackup	string	SQL Server 執行個體備份模式，分為常規備份模式（支援全量和增量恢複）和僅複製模式（僅支援全量恢複），傳回值： 0：常規備份模式 1：僅複製模式	0
DBInstanceId	string	執行個體 ID。	rm-uf6wjk5****
Encryption	string	備份組的加密資訊。	{}
Engine	string	資料庫類型。傳回值： MySQL SQLServer PostgreSQL MariaDB	MySQL
EngineVersion	string	資料庫版本。	8.0
HostInstanceID	string	產生備份組的執行個體編號，用於區分該備份組產生於主執行個體或備執行個體。	5882781
IsAvail	integer	備份組是否可用，傳回值： 0：不可用 1：可用	1
MetaStatus	string	庫表恢複的備份組狀態，傳回值： OK：正常。 LARGE：表數量過多，不能用於庫表恢複。 EMPTY：備份失敗的備份組。說明空串表示未開通庫表恢複的備份組。	OK
StorageClass	string	備份組的儲存介質，傳回值： 0：常規儲存 1：Archive Storage	0
StoreStatus	string	該資料備份是否可刪除，傳回值： Enabled：可刪除 Disabled：不可刪除	Disabled
ExpectExpireTime	string	備份組到期時間，格式為yyyy-MM-ddTHH:mmZ（UTC 時間）。說明僅 SQL Server 單庫備份設定備份組保留天數後返回該值。	2025-06-17T12:10:23Z
PageNumber	string	頁碼。	1
PageRecordCount	string	本頁備份組個數。	30
RequestId	string	請求 ID。	1A6D328C-84B8-40DC-BF49-6C73984D7494
TotalEcsSnapshotSize	integer	執行個體的快照鏈大小，單位：位元組（Byte）。	0
TotalRecordCount	string	總記錄數。	100

樣本

正常返回樣本

JSON格式

{
  "Items": {
    "Backup": [
      {
        "BackupDownloadLinkByDB": {
          "BackupDownloadLinkByDB": [
            {
              "DataBase": "dbs",
              "DownloadLink": "https://cn-hangzhou.bak.rds.aliyuncs.com/custins53664665/hins18676859_2021072909473127987849.zip?Expires=****&dbList=tb1",
              "IntranetDownloadLink": "https://cn-hangzhou-internal.bak.rds.aliyuncs.com/custins53664665/hins18676859_2021072909473127987849.zip?Expires=****&dbList=tb1"
            }
          ]
        },
        "BackupDownloadURL": "http://rdsbak-hz-v3.oss-cn-hangzhou.aliyuncs.com/****",
        "BackupEndTime": "2019-02-13T12:20:00Z",
        "BackupId": "321020562",
        "BackupInitiator": "System",
        "BackupIntranetDownloadURL": "http://rdsbak-hz-v3.oss-cn-hangzhou-internal.aliyuncs.com/****",
        "BackupMethod": "Physical",
        "BackupMode": "Automated",
        "BackupSize": 2167808,
        "BackupStartTime": "2019-02-03T12:20:00Z",
        "BackupStatus": "Success",
        "BackupType": "FullBackup",
        "Checksum": "1835830439****",
        "ConsistentTime": 1576506856,
        "CopyOnlyBackup": "0",
        "DBInstanceId": "rm-uf6wjk5****",
        "Encryption": "{}",
        "Engine": "MySQL",
        "EngineVersion": "8.0",
        "HostInstanceID": "5882781",
        "IsAvail": 1,
        "MetaStatus": "OK",
        "StorageClass": "0",
        "StoreStatus": "Disabled",
        "ExpectExpireTime": "2025-06-17T12:10:23Z"
      }
    ]
  },
  "PageNumber": "1",
  "PageRecordCount": "30",
  "RequestId": "1A6D328C-84B8-40DC-BF49-6C73984D7494",
  "TotalEcsSnapshotSize": 0,
  "TotalRecordCount": "100"
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
400	InvalidRestoreTime.Malformed	The requested restoreTime param is invalid, or the requested restoreTime is not within the scope of the instance backup.	請求的restoreTime參數無效，或者請求的resstoreTime不在執行個體備份的範圍內。
400	InvalidPageNumbers.Malformed	Specified page number is not valid.	頁碼數不存在。
400	InvalidStartTime.Format	Specified start time is not valid.	指定的起始時間無效。
400	InvalidEndTime.Format	Specified end time is not valid.	您提交的結束時間無效，請重新提交正確資訊
400	InvalidParameterCombination	The end time must be greater than the start time	結束時間必須晚於開始時間。
400	InvalidDBinstanceClass.ValueNotSupported	The specified parameter DBinstanceClass is invalid.	指定的參數“執行個體規格”無效
400	InvalidBackupSetLocation.Format	Specified backup set location is not valid.	指定的備份組位置無效。
400	Order.ComboInstanceNotAllowOperate	A package instance is not allowed to operate independently.	套餐執行個體不允許單獨操作。
400	Price.PricingPlanResultNotFound	Pricing plan price result not found.	定價計劃價格結果沒有找到。
400	Order.NoRealNameAuthentication	You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.	您還未通過實名認證，不符合購買條件，請登入費用與成本進行實名認證。
400	InsufficientAvailableQuota	Your account quota limit is less than 0, please recharge before trying to purchase.	您的賬戶可用額度小於0，請先儲值後再嘗試購買。
400	CommodityServiceCalling.Exception	Failed to call commodity service.	調用商品服務返回失敗。
400	RegionDissolvedEOM	Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.	客戶您好，阿里雲計劃對當前地區進行最佳化調整，該地區雲端服務將停止營運，為確保您的商務持續性及資料移轉工作的平穩過渡，您目前無法操作新購類型的訂單，感謝理解與支援。
400	Commodity.InvalidComponent	The module you purchased is not legal, please buy it again.	您購買的模組不合法，請重新購買。
400	RegionEndTimeDissolvedAustralia	Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.	客戶您好，該地區已裁撤。
400	Price.CommoditySys	Commodity system call exception.	商品系統調用異常。
400	Pay.InsufficientBalance	Insufficient available balance.	可用金不足。
400	Order.PeriodInvalid	There is a problem with the period you selected, please choose again.	您選購的周期有問題，請重新選購。
400	pay.noCreditCard	Account not bound to credit card.	賬戶未綁定信用卡。
400	Order.InstHasUnpaidOrder	There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.	您選購的服務存在未支付訂單，請支付或作廢后再下單。
400	noAvailablePaymentMethod	No payment method is specified for your account. We recommend that you add a payment method.	沒有為您的賬戶指定付款條件。我們建議您添加一種付款條件。
400	BasicInfoUncompleted	Your information is incomplete. Complete your information before the operation.	您的基本資料未完善，請在操作前先完善您的基本資料。
400	Risk.RiskControlRejection	Your account is abnormal, please contact customer service for details.	您的賬戶出現異常，詳情請聯絡客服。
400	Api.NotSupport	Specified api is not supported.	當前介面不支援。
400	ContainForbiddenLabelError	There is a label that prohibits placing orders. Please contact your distributor for assistance.	存在禁止下單的標籤，請聯絡您的分銷商處理
400	InvalidDBInstanceId.NotFound	The DBInstanceId provided does not exist in records.	提供的DBInstanceId不存在。
400	InvalidInstanceLevel.DiskType	Specified instance level not support request disk type	當前執行個體規格不支援該儲存類型。
400	InvalidParam	Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.	指定的 wal_level 參數無效。執行個體中仍然存在複製槽，因此無法將其設定為replica。
400	KmsApiError	User secret key invalid.	使用者密鑰失效。
400	System.SaleValidateFailed	Sales expression validation system error.	銷售運算式校正系統錯誤。
400	Abs.InvalidAccount.NotFound	account is not found.	賬戶不存在。
400	SqlExecuteFailedOrTimeout	sql command execution failed or timed out:%s.	sql命令執行失敗或執行逾時
400	ColdData.EngineVersionNotSupport	The current instance engine version not support coldDataEnabled.	當前執行個體引擎版本不支援歸檔冷資料。
400	ColdData.MinorVersionNotSupport	The current instance minor version not support coldDataEnabled.	當前核心版本不支援歸檔冷資料。
400	IncorrectTargetClasscode	The current instance type does not support this operation.	當前規格不支援此操作。
400	InvalidConnectionString.Duplicate	Specified connection string already exists in the RDS.	連結地址名重複，請重新設定連接字串。
400	RequiredParam.NotFound	Required input param is not found.	沒有傳入必要的參數。
400	Parameters.Invalid	Parameter error, please check the parameters.	參數錯誤，請檢查參數。
400	BackupPolicyNotSupport	Cold Data won't open with CrossBackup or Flash Backup, please check Backup Policy.	資料歸檔不支援跨地區備份和秒級快照，請檢查備份策略。
400	InvalideStatus.Format	The instance status does not support this operation.	執行個體狀態不支援此操作。
400	InvalidReleasedKeepPolicy.Format	Specified Released Keep Policy is not valid.	執行個體釋放後的歸檔備份保留原則無效。
400	InvalidDBInstanceEngineType.Format	the DB instance engine type does not support this operation.	DB執行個體引擎類型不支援此操作。
400	Pay.NoCreditCard	No credit cards.	無信用卡。
400	VpcNetworkTypeNotSupport	The vpc network type instance does not support this operation.	vpc網路類型執行個體不支援此操作。
400	MirrorInsExists	Specified DB instance mirror ins already existed.	當前資料庫執行個體鏡像已存在。
400	UnsupportedClassCode	The specified DB instance class stops selling.	執行個體規格停止售賣。
400	InvalidBackupSet	The specified database does not exist in the backup set.	備份組中沒有指定的資料庫。
400	OrdTCommodityQueryError	Failed to query for product.	查詢產品失敗。
400	ProductInstanceReleased	The instance has been released. Please check before placing the order.	執行個體已釋放，請核實後下單。
400	RegionEndTimeDissolvedIndia	The region is no longer supported.	指定的地區無效。
500	ExternalFailure	The request processing has failed due to external service failure.	請求服務失敗，請稍後重試。
500	RequestMetaDataFailed	The service request failed. Please try again later or contact service personnel.	請求服務失敗，請稍後再試或聯絡服務人員。
500	InvokeProxyFailure	The request processing has failed due to service failure of rds api.	由於rds api服務失敗，請求處理失敗。
403	InvalidMaxRecordsPerPage.Malformed	Specified record number is not valid.	指定的記錄號不正確。
403	IncorrectDBInstanceState	Current DB instance state does not support this operation.	當前執行個體狀態不支援此操作。
403	OrderStatus.UnPaid	The specified db instance has unpaid order.	執行個體當前存在未支付訂單，請支付後重試。
403	InvalidReduceDiskSize	The storage capacity after the scale-down must be larger than the used amount.	縮容目標容量不能小於當前儲存空間使用量
403	CloudSSDNotSupport	Cloud ssd does not support this operation, please upgrade to essd.	SSD盤不支援此操作，請升級至ESSD。
403	InvalidUserOperatorPermission	The user permission does not support this operation.	使用者權限不支援此操作。
403	InvalidVswitchId	Specified conn vswitch id is not valid.	指定的VSwitchId格式不正確或為空白
403	IncorrectMinorVersion	Current engine minor version does not support operations.	當前引擎小版本不支援此操作。
403	OperationDenied.ZoneResource	There is no available zone for inventory.	沒有可用的庫存地區。
403	NotInFlowController	Sorry,no permission.	非集團上雲使用者不可用，無許可權。
403	InvalidKmsKey	Kms key is disabled.	Kms key已禁用。
403	InvalidInstanceLevel.Malformed	Current DB instance level does not support this operation.	當前資料庫執行個體層級不支援此操作。
404	InvalidDBInstanceName.NotFound	The database instance does not exist.	資料庫執行個體名稱不存在。請確認資料名稱是否正確。
404	InvalidDBInstance.NotFound	The specified instance does not exist or is not supported.	沒有找到指定的執行個體，請檢查執行個體的正確性。
404	Request.NotFound	The requested resource is not available.	請求的資源不可用。
404	InvalidClusterKms	The current instance does not authorized to access the Key Management Service.	當前執行個體未授權存取金鑰管理服務。
404	HostInfo.NotFound	The specified host info is not found.	指定的主機資訊不存在。

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

變更歷史

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