DescribeBackupDataList - Data Management - Alibaba Cloud Documentation Center

Queries the details of backups for a PolarDB for MySQL cluster.

Operation description

Applicable engines

PolarDB for MySQL

Note

This API operation is available only to specific customers. To use this operation, join the DBS Customer Service DingTalk group (ID: 35585947) to request access.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

dbs:DescribeBackupDataList

list

DBInstance

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

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceName	string	No	The ID of the PolarDB cluster.	pc-2ze3nrr64c5******
RegionCode	string	No	The region where the backup set is located.	cn-hangzhou
SceneType	string	No	The backup scenario. This parameter supports only LEVEL_1, which indicates a level-1 backup in the region where the instance resides.	LEVEL_1
StartTime	string	No	The start of the time range to query. Specify the time 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. Specify the time in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.	2024-04-17T17:00:32Z
BackupStatus	string	No	The status of the backup set. Valid values: OK: The backup is successful. ERROR: The backup failed.	OK
BackupId	string	No	The ID of the backup set.	213064****
BackupMethod	string	No	The backup method. Valid values: Physical: physical backup Logical: logical backup Snapshot: snapshot backup	Snapshot
BackupMode	string	No	The backup mode. Valid values: Automated: automatic backup Manual: manual backup	Automated
BackupType	string	No	The backup type. Valid values: FullBackup: full backup IncrementBackup: incremental backup	FullBackup
BackupScale	string	No	The backup scope. Valid values: DBInstance: instance backup DBTable: database and table backup	DBInstance
PageSize	integer	No	The number of entries to return on each page. The default value is 20.	20
PageNumber	integer	No	The page number. The value must be an integer that is greater than 0 and does not exceed the maximum value of the integer data type. The default value is 1.	1
InstanceIsDeleted	boolean	No	Specifies whether the instance is deleted. Valid values: true: The instance is deleted. false: The instance is not deleted. This is the default value.	false
InstanceRegion	string	No	The original region of the instance.	cn-hangzhou
DataSourceId	string	No	This parameter is reserved and does not need to be specified.	test****

Response elements

Element	Type	Description	Example
	object	The details of the returned parameters.
Data	object	The returned data.
Content	array<object>	The details of the task.
	array<object>	The details of the task.
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: automatic backup Manual: manual backup	Automated
BackupType	string	The backup type. Valid values: FullBackup: full backup IncrementBackup: incremental backup	FullBackup
BackupScale	string	The backup scope. Valid values: DBInstance: instance backup DBTable: database and table backup	DBInstance
BackupMethod	string	The backup method. Valid values: Physical: physical backup Logical: logical backup Snapshot: snapshot backup	Snapshot
BackupSize	integer	The size of the backup set in bytes.	25669140480
BackupStatus	string	The status of the backup set. Valid values: OK: The backup is successful. 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 displayed 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 displayed in UTC.	2024-04-17T17:00:32Z
ConsistentTime	integer	The point in time of the consistent snapshot. The value is a UNIX timestamp. Unit: seconds.	1713373221
BackupLocation	string	The storage path of the backup.	logic
InstanceName	string	The ID of the instance.	pc-2ze3nrr64c5******
Engine	string	The database engine type.	polardb_mysql
EngineVersion	string	The database 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 encryption information.	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.	84a4c16431f969712e6895992719****
BackupDownloadURL	string	The public download URL of the backup set. Note This parameter is returned only when BackupMethod is set to Physical (physical backup) or Logical (logical backup).	http://oss.com/****
BackupIntranetDownloadURL	string	The internal download URL of the backup set. Note This parameter is returned only when BackupMethod is set to Physical (physical backup) or Logical (logical backup).	http://oss.com/****
ExpectExpireType	string	The expected expiration type of the backup set. Valid values: NEVER EXPIRED DELAY	DELAY
ExpectExpireTime	string	The expected expiration time of the backup set. The time is 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 level-2 dump of the PolarDB cluster. Note The PolarSnapshot-related information is returned only after the level-2 dump feature is enabled for the PolarDB cluster in the same region and the level-1 backup is successfully dumped.
DumpId	integer	The ID of the dump.	abc****
DumpSize	integer	The size of the dump backup in bytes.	25669140589
expectExpireType	string	The expected expiration type of the backup set. Valid values: NEVER EXPIRED DELAY	DELAY
ExpectExpireTime	string	The expected expiration time of the backup set. The time is in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2024-04-19T05:00:49Z
PageSize	integer	The page size.	20
PageNumber	integer	The page number.	1
TotalPages	integer	The total number of pages.	1
TotalElements	integer	The total number of backup sets.	1
Extra	string	Extra information.	dbtest
RequestId	string	The ID of the request.	95A5FFD0-7F46-5A7D-9DFE-6A376B4E2A28
ErrCode	string	The error code.	Request.Forbidden
Success	string	Indicates whether the request was successful. Valid values: true: The request was successful. false: The request failed.	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

Success response

JSON format

{
  "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	Description
403	Request.Forbidden	Have no Permissions

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.

Data Management:DescribeBackupDataList