DescribeBackupDataList - Database Backup - Alibaba Cloud Documentation Center

Queries the information about the backup data of a PolarDB for MySQL cluster.

Operation description

Supported database engine

PolarDB for MySQL

Note This API operation is available only to specific customers. If you want to call this API operation, join the Database Backup (DBS) DingTalk group (ID: 35585947) for customer consultation to request permissions.

References

Back up data of PolarDB for MySQL

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
dbs:DescribeBackupDataList	list	DBInstance acs:rds:{#regionId}:{#accountId}:dbinstance/{#DbInstanceId}	none	none

Request parameters

Parameter	Type	Required	Description	Example
InstanceName	string	No	The ID of the PolarDB for MySQL cluster.	pc-2ze3nrr64c5******
RegionCode	string	No	The region in which the backup set resides.	cn-hangzhou
SceneType	string	No	The type of the backup scenario. Set the value to LEVEL_1, which indicates the level-1 backup of the region in which the PolarDB for MySQL cluster resides.	LEVEL_1
StartTime	string	No	The beginning of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.	2024-04-17T17:00:16Z
EndTime	string	No	The end of the time range to query. The end time must be later than the start time. The time follows the yyyy-MM-ddTHH:mm:ssZ format and is displayed in UTC.	2024-04-17T17:00:32Z
BackupStatus	string	No	The status of the backup set. Valid values: OK: The backup succeeded. ERROR: The backup failed.	OK
BackupId	string	No	The ID of the backup set.	213064****
BackupMethod	string	No	The backup method. Valid values: Physical Logical Snapshot	Snapshot
BackupMode	string	No	The backup mode. Valid values: Automated Manual	Automated
BackupType	string	No	The backup type. Valid values: FullBackup IncrementBackup	FullBackup
BackupScale	string	No	The backup scale. Valid values: DBInstance DBTable	DBInstance
PageSize	integer	No	The number of entries per page. Default value: 20.	20
PageNumber	integer	No	The page number. The value must be a positive integer that does not exceed the maximum value of the INTEGER data type. Default value: 1.	1
InstanceIsDeleted	boolean	No	Specifies whether the cluster is deleted. Valid values: true false (default)	false
InstanceRegion	string	No	The region in which the original cluster resides.	cn-hangzhou
DataSourceId	string	No	This is a reserved parameter.	test****

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
Data	object	The returned data.
Content	array<object>	The information about the task.
	object
BackupId	string	The ID of the backup set.	213088****
BackupName	string	The name of the backup set.	logic_backup
BackupMode	string	The backup mode. Valid values: Automated Manual	Automated
BackupType	string	The backup type. Valid values: FullBackup IncrementBackup	FullBackup
BackupScale	string	The backup scale. Valid values: DBInstance DBTable	DBInstance
BackupMethod	string	The backup method. Valid values: Physical Logical Snapshot	Snapshot
BackupSize	long	The size of the backup set. Unit: byte.	25669140480
BackupStatus	string	The status of the backup set. Valid values: OK: The backup succeeded. ERROR: The backup failed.	OK
BackupStartTime	string	The start time of the backup. The time is in the yyyy-MM-ddTHH:mm:ssZ format. The time is in UTC.	2024-04-17T17:00:16Z
BackupEndTime	string	The end time of the backup. The time is in the yyyy-MM-ddTHH:mm:ssZ format. The time is in UTC.	2024-04-17T17:00:32Z
ConsistentTime	long	The snapshot checkpoint time. This value is a UNIX timestamp representing the number of seconds that have elapsed since January 1, 1970, 00:00:00 UTC.	1713373221
BackupLocation	string	The storage path of backup files.	logic
InstanceName	string	The instance ID.	pc-2ze3nrr64c5******
Engine	string	The type of the database engine.	polardb_mysql
EngineVersion	string	The engine version.	5.7
SupportDeletion	integer	Indicates whether the backup set can be deleted. Valid values: 0: The backup set can be deleted. 1: The backup set cannot be deleted.	0
Encryption	string	The information about the encryption.	psk2
IsAvail	integer	Indicates whether the backup set is available. Valid values: 1: The backup set is available. 0: The backup set is unavailable.	1
Checksum	string	The checksum value.	84a4c16431f969712e6895992719****
BackupDownloadURL	string	The URL that is used to download the backup set over the Internet. Note This parameter is returned only when the value of BackupMethod is Physical or Logical.	http://oss.com/****
BackupIntranetDownloadURL	string	The URL that is used to download the backup set over the internal network. Note This parameter is returned only when the value of BackupMethod is Physical or Logical.	http://oss.com/****
ExpectExpireType	string	Indicates whether the backup set expires. Valid values: NEVER: The backup set does not expire. EXPIRED: The backup set expired. DELAY: The backup set expires after a specific period of time.	DELAY
ExpectExpireTime	string	The time when the backup set expires. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2024-04-19T05:00:49Z
PolarSnapshot	object	The information about the PolarDB level-2 dump. Note This parameter is returned only if the level-2 dump feature is enabled for the PolarDB for MySQL cluster and the level-1 backup is dumped.
DumpId	long	The dump backup ID.	abc****
DumpSize	long	The size of the dump backup. Unit: byte.	25669140589
expectExpireType	string	Indicates whether the backup set expires. Valid values: NEVER: The backup set does not expire. EXPIRED: The backup set expired. DELAY: The backup set expires after a specific period of time.	DELAY
ExpectExpireTime	string	The time when the backup set expires. The time follows the ISO 8601 standard in the YYYY-MM-DDThh:mm:ssZ format. The time is displayed in UTC.	2024-04-19T05:00:49Z
PageSize	long	The number of entries per page.	20
PageNumber	long	The page number of the returned page.	1
TotalPages	long	The total number of pages returned.	1
TotalElements	long	The total number of backup sets.	1
Extra	string	The additional information.	dbtest
RequestId	string	The request ID.	95A5FFD0-7F46-5A7D-9DFE-6A376B4E2A28
ErrCode	string	The error code.	Request.Forbidden
Success	string	Indicates whether the operation was successful. Valid values: true false	true
ErrMessage	string	The error message.	The specified parameter %s value is not valid.
Code	string	The status code.	Success
Message	string	The returned message.	The specified parameter %s value is not valid.

Examples

Sample success responses

JSONformat

{
  "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."
}

Error codes

HTTP status code	Error code	Error message
403	Request.Forbidden	Have no Permissions

For a list of error codes, visit the Service error codes.