使用DescribeBackupDataList查詢PolarDB MySQL版備份資料-Data Management-阿里雲

查詢PolarDB MySQL版備份資料詳情。

介面說明

適用引擎

PolarDB MySQL 版

說明

當前該介面僅針對特定客戶開放使用，如有需求，請到 DBS 客戶諮詢群（DingTalk群號：35585947）申請使用。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

dbs:DescribeBackupDataList

list

DBInstance

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

無

請求參數

名稱	類型	必填	描述	樣本值
InstanceName	string	否	PolarDB 執行個體 ID。	pc-2ze3nrr64c5******
RegionCode	string	否	備份組所在地區。	cn-hangzhou
SceneType	string	否	備份情境類型，當前僅支援LEVEL_1，即執行個體所在地區的一級備份。	LEVEL_1
StartTime	string	否	查詢開始時間，格式：yyyy-MM-ddTHH:mm:ssZ（UTC 時間）。	2024-04-17T17:00:16Z
EndTime	string	否	查詢結束時間，需要大於查詢開始時間。格式：yyyy-MM-ddTHH:mm:ssZ（UTC 時間）。	2024-04-17T17:00:32Z
BackupStatus	string	否	備份組狀態，取值如下： OK：備份成功 ERROR：備份失敗	OK
BackupId	string	否	備份組 ID。	213064****
BackupMethod	string	否	備份方式，取值如下： Physical：物理備份 Logical：邏輯備份 Snapshot：快照備份	Snapshot
BackupMode	string	否	備份模式，取值如下： Automated：系統自動備份 Manual：手動備份	Automated
BackupType	string	否	備份類型，取值如下： FullBackup：全量備份 IncrementBackup：增量備份	FullBackup
BackupScale	string	否	備份規格，取值如下： DBInstance：執行個體備份 DBTable：庫表備份	DBInstance
PageSize	integer	否	每頁記錄數，預設值為 20。	20
PageNumber	integer	否	頁碼，取值範圍為大於 0 但不超過 Integer 最大值的整數，預設值為 1。	1
InstanceIsDeleted	boolean	否	執行個體是否已刪除，取值如下： true：已刪除 false：未刪除（預設值）	false
InstanceRegion	string	否	原執行個體所在地區。	cn-hangzhou
DataSourceId	string	否	預留參數，暫無需關注。	test****

返回參數

名稱	類型	描述	樣本值
	object	返回參數詳情。
Data	object	返回資料如下。
Content	array<object>	任務詳情。
	array<object>	任務詳情。
BackupId	string	備份組 ID。	213088****
BackupName	string	備份組名稱。	logic_backup
BackupMode	string	備份模式，傳回值如下： Automated：系統自動備份 Manual：手動備份	Automated
BackupType	string	備份類型，傳回值如下： FullBackup：全量備份 IncrementBackup：增量備份	FullBackup
BackupScale	string	備份規格，傳回值如下： DBInstance：執行個體備份 DBTable：庫表備份	DBInstance
BackupMethod	string	備份方式，傳回值如下： Physical：物理備份 Logical：邏輯備份 Snapshot：快照備份	Snapshot
BackupSize	integer	備份組大小，單位 Byte。	25669140480
BackupStatus	string	備份組狀態，傳回值如下： OK：備份成功 ERROR：備份失敗	OK
BackupStartTime	string	備份開始時間，格式：yyyy-MM-ddTHH:mm:ssZ（UTC 時間）。	2024-04-17T17:00:16Z
BackupEndTime	string	備份結束時間，格式：yyyy-MM-ddTHH:mm:ssZ（UTC 時間）。	2024-04-17T17:00:32Z
ConsistentTime	integer	一致性快照的時間點，格式為 Unix 時間戳記，單位為秒（s）。	1713373221
BackupLocation	string	備份儲存路徑。	logic
InstanceName	string	執行個體 ID。	pc-2ze3nrr64c5******
Engine	string	引擎類型。	polardb_mysql
EngineVersion	string	引擎版本。	5.7
SupportDeletion	integer	備份組是否支援刪除，傳回值如下： 0：支援 1：不支援	0
Encryption	string	加密資訊。	psk2
IsAvail	integer	備份組是否可用，傳回值如下： 1：可用 0：不可用	1
Checksum	string	校正碼。	84a4c16431f969712e6895992719****
BackupDownloadURL	string	備份組公網下載地址。說明僅當 BackupMethod 為 Physical（物理備份）或 Logical（邏輯備份）時，返回該參數。	http://oss.com/****
BackupIntranetDownloadURL	string	備份組內網下載地址。說明僅當 BackupMethod 為 Physical（物理備份）或 Logical（邏輯備份）時，返回該參數。	http://oss.com/****
ExpectExpireType	string	備份組預期到期類型，傳回值如下： NEVER EXPIRED DELAY	DELAY
ExpectExpireTime	string	備份組預期到期時間，格式：yyyy-MM-ddTHH:mm:ssZ（UTC 時間）。	2024-04-19T05:00:49Z
PolarSnapshot	object	PolarDB 二級轉儲資訊。說明僅當 PolarDB 執行個體開啟同地區二級轉儲功能，並且一級備份轉儲成功後，才會返回 PolarSnapshot 相關資訊。
DumpId	integer	轉儲 ID。	abc****
DumpSize	integer	轉儲備份大小，單位為 Byte。	25669140589
expectExpireType	string	備份組預期到期類型，傳回值如下： NEVER EXPIRED DELAY	DELAY
ExpectExpireTime	string	備份組預期到期時間，格式：yyyy-MM-ddTHH:mm:ssZ（UTC 時間）。	2024-04-19T05:00:49Z
PageSize	integer	分頁大小。	20
PageNumber	integer	分頁頁碼。	1
TotalPages	integer	分頁總頁數。	1
TotalElements	integer	備份組總個數。	1
Extra	string	額外資訊。	dbtest
RequestId	string	請求 ID。	95A5FFD0-7F46-5A7D-9DFE-6A376B4E2A28
ErrCode	string	錯誤碼。	Request.Forbidden
Success	string	請求是否成功，傳回值如下： true：請求成功 false：請求失敗	true
ErrMessage	string	錯誤資訊。	The specified parameter %s value is not valid.
Code	string	狀態代碼。	Success
Message	string	返回資訊。	The specified parameter %s value is not valid.

樣本

正常返回樣本

JSON格式

{
  "Data": {
    "Content": [
      {
        "BackupId": "213088****",
        "BackupName": "logic_backup",
        "BackupMode": "Automated",
        "BackupType": "FullBackup",
        "BackupScale": "DBInstance",
        "BackupMethod": "Snapshot",
        "BackupSize": 25669140480,
        "BackupStatus": "OK",
        "BackupStartTime": "2024-04-17T17:00:16Z",
        "BackupEndTime": "2024-04-17T17:00:32Z",
        "ConsistentTime": 1713373221,
        "BackupLocation": "logic",
        "InstanceName": "pc-2ze3nrr64c5******",
        "Engine": "polardb_mysql",
        "EngineVersion": "5.7",
        "SupportDeletion": 0,
        "Encryption": "psk2",
        "IsAvail": 1,
        "Checksum": "84a4c16431f969712e6895992719****",
        "BackupDownloadURL": "http://oss.com/****",
        "BackupIntranetDownloadURL": "http://oss.com/****",
        "ExpectExpireType": "DELAY",
        "ExpectExpireTime": "2024-04-19T05:00:49Z",
        "PolarSnapshot": {
          "DumpId": 0,
          "DumpSize": 25669140589,
          "expectExpireType": "DELAY",
          "ExpectExpireTime": "2024-04-19T05:00:49Z"
        }
      }
    ],
    "PageSize": 20,
    "PageNumber": 1,
    "TotalPages": 1,
    "TotalElements": 1,
    "Extra": "dbtest"
  },
  "RequestId": "95A5FFD0-7F46-5A7D-9DFE-6A376B4E2A28",
  "ErrCode": "Request.Forbidden\t",
  "Success": "true",
  "ErrMessage": "The specified parameter %s value is not valid. ",
  "Code": "Success",
  "Message": "The specified parameter %s value is not valid."
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
403	Request.Forbidden	Have no Permissions	當前操作未被授權，請聯絡主帳號在RAM控制台進行授權後再執行操作

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

變更歷史

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

Data Management：DescribeBackupDataList - 查詢備份資料