All Products
Search
Document Center

Database Backup:DescribeBackupDataList

Last Updated:Nov 14, 2024

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

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

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.
OperationAccess levelResource typeCondition keyAssociated operation
dbs:DescribeBackupDataListlist
  • DBInstance
    acs:rds:{#regionId}:{#accountId}:dbinstance/{#DbInstanceId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
InstanceNamestringNo

The ID of the PolarDB for MySQL cluster.

pc-2ze3nrr64c5******
RegionCodestringNo

The region in which the backup set resides.

cn-hangzhou
SceneTypestringNo

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
StartTimestringNo

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
EndTimestringNo

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
BackupStatusstringNo

The status of the backup set. Valid values:

  • OK: The backup succeeded.
  • ERROR: The backup failed.
OK
BackupIdstringNo

The ID of the backup set.

213064****
BackupMethodstringNo

The backup method. Valid values:

  • Physical
  • Logical
  • Snapshot
Snapshot
BackupModestringNo

The backup mode. Valid values:

  • Automated
  • Manual
Automated
BackupTypestringNo

The backup type. Valid values:

  • FullBackup
  • IncrementBackup
FullBackup
BackupScalestringNo

The backup scale. Valid values:

  • DBInstance
  • DBTable
DBInstance
PageSizeintegerNo

The number of entries per page. Default value: 20.

20
PageNumberintegerNo

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
InstanceIsDeletedbooleanNo

Specifies whether the cluster is deleted. Valid values:

  • true
  • false (default)
false
InstanceRegionstringNo

The region in which the original cluster resides.

cn-hangzhou
DataSourceIdstringNo

This is a reserved parameter.

test****

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

Dataobject

The returned data.

Contentarray<object>

The information about the task.

Contentobject
BackupIdstring

The ID of the backup set.

213088****
BackupNamestring

The name of the backup set.

logic_backup
BackupModestring

The backup mode. Valid values:

  • Automated
  • Manual
Automated
BackupTypestring

The backup type. Valid values:

  • FullBackup
  • IncrementBackup
FullBackup
BackupScalestring

The backup scale. Valid values:

  • DBInstance
  • DBTable
DBInstance
BackupMethodstring

The backup method. Valid values:

  • Physical
  • Logical
  • Snapshot
Snapshot
BackupSizelong

The size of the backup set. Unit: byte.

25669140480
BackupStatusstring

The status of the backup set. Valid values:

  • OK: The backup succeeded.
  • ERROR: The backup failed.
OK
BackupStartTimestring

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
BackupEndTimestring

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
ConsistentTimelong

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
BackupLocationstring

The storage path of backup files.

logic
InstanceNamestring

The instance ID.

pc-2ze3nrr64c5******
Enginestring

The type of the database engine.

polardb_mysql
EngineVersionstring

The engine version.

5.7
SupportDeletioninteger

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
Encryptionstring

The information about the encryption.

psk2
IsAvailinteger

Indicates whether the backup set is available. Valid values:

  • 1: The backup set is available.
  • 0: The backup set is unavailable.
1
Checksumstring

The checksum value.

84a4c16431f969712e6895992719****
BackupDownloadURLstring

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/****
BackupIntranetDownloadURLstring

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/****
ExpectExpireTypestring

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
ExpectExpireTimestring

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
PolarSnapshotobject

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.
DumpIdlong

The dump backup ID.

abc****
DumpSizelong

The size of the dump backup. Unit: byte.

25669140589
expectExpireTypestring

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
ExpectExpireTimestring

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
PageSizelong

The number of entries per page.

20
PageNumberlong

The page number of the returned page.

1
TotalPageslong

The total number of pages returned.

1
TotalElementslong

The total number of backup sets.

1
Extrastring

The additional information.

dbtest
RequestIdstring

The request ID.

95A5FFD0-7F46-5A7D-9DFE-6A376B4E2A28
ErrCodestring

The error code.

Request.Forbidden
Successstring

Indicates whether the operation was successful. Valid values:

  • true
  • false
true
ErrMessagestring

The error message.

The specified parameter %s value is not valid.
Codestring

The status code.

Success
Messagestring

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 codeError codeError message
403Request.ForbiddenHave no Permissions

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