You can call the ListUserBackupFiles operation to query the details about one or more full backup files that are imported into ApsaraDB RDS for MySQL instances in a region.
- A full backup file contains the data of a self-managed MySQL database. You can restore the data of a self-managed MySQL database from a full backup file to an ApsaraDB RDS for MySQL instance. For more information, see Migrate the data of a self-managed MySQL 5.7 instance to the cloud.
- Before you call the CreateDBInstance operation to create an ApsaraDB RDS for MySQL instance into which you want to import full backup files, you can call the ListUserBackupFiles operation to query the IDs of full backup files.
- You can call the ImportUserBackupFile operation to import a full backup file into an ApsaraDB RDS for MySQL instance.
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | Yes | ListUserBackupFiles |
The operation that you want to perform. Set the value to ListUserBackupFiles. |
Status | String | No | CheckSuccess |
The status of the full backup files. Valid values:
|
RegionId | String | Yes | cn-hangzhou |
The region ID of the instance. You can call the DescribeRegions operation to query the most recent region list. |
Comment | String | No | BackupTest |
The part of the description that is included in the descriptions of the full backup files. Note The system implements a fuzzy match based on the value of this parameter.
|
BackupId | String | No | b-kwwvr7v8t7of******** |
The ID of the full backup file. |
OssUrl | String | No | https://******.oss-ap-********.aliyuncs.com/backup_qp.xb |
The URL from which you can download the full backup file that is stored as an object in an Object Storage Service (OSS) bucket. For more information about how to obtain the URL, see Obtain the access URL after you upload objects. |
Tags | String | No | key1:value1 |
The tag that is added to the full backup files. |
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
RequestId | String | AD67C22F-64F3-4448-A9A8-D1606D242879 |
The ID of the request. |
Records | Array of Records |
An array that consists of the information about the full backup files that are returned. |
|
Status | String | BackupSuccess |
The status of the full backup file. Valid values:
|
CreationTime | String | 1623231084000 |
The time when the system started to import the full backup file. The value of this parameter is a UNIX timestamp. Unit: milliseconds. |
FinishTime | String | 1623231750000 |
The time when the system finished importing the full backup file. The value of this parameter is a UNIX timestamp. Unit: milliseconds. |
Comment | String | BackupTest |
The description of the full backup file. |
OssFilePath | String | test/backup_qp.xb |
The path of the full backup file that is stored as an object in an OSS bucket. |
OssBucket | String | BackupTest |
The name of the OSS bucket in which the full backup file is stored as an object. |
ModificationTime | String | 1623231750000 |
The time when the system finished importing the full backup file. The value of this parameter is a UNIX timestamp. Unit: milliseconds. |
OssFileSize | Long | 79115 |
The size of the full backup file that is stored as an object in an OSS bucket. Unit: KB. |
OssFileName | String | backup_qp.xb |
The name of the full backup file that is stored as an object in an OSS bucket. |
EngineVersion | String | 5.7 |
The database engine version that the instance runs. |
BackupId | String | b-kwwvr7v8t7of******** |
The ID of the full backup file. |
RestoreSize | String | 20 |
The amount of storage that is required to restore the data of the full backup file. Unit: GB. |
ZoneId | String | cn-hangzhou-b |
The zone ID of the full backup file. |
Retention | Integer | 3 |
The retention period of the full backup file. Unit: days. |
Engine | String | mysql |
The database engine of the instance. |
OssUrl | String | https://******.oss-ap-********.aliyuncs.com/backup_qp.xb |
The OSS download URL of the full backup file. |
OssFileMetaData | String | {\"Accept-Ranges\":\"bytes\",\"Connection\":\"keep-alive\",\"Content-Length\":81014337,\"Content-Type\":\"application/octet-stream\",\"Date\":1623309548000,\"ETag\":\"889FE9E5FCEBFE4781829488A352863B-1\",\"Last-Modified\":1622186844000,\"Server\":\"AliyunOSS\",\"x-oss-hash-crc64ecma\":\"5793608435727323129\",\"x-oss-object-type\":\"Multipart\",\"x-oss-request-id\":\"60C1BCEC92572F37318BD499\",\"x-oss-server-time\":\"166\",\"x-oss-storage-class\":\"Standard\"} |
The metadata of the full backup file. For more information, see Manage object metadata. |
BinlogInfo | String | {\"binlogPosition\":\"154\",\"binlogFile\":\"0.000002\"} |
The information about the binary log file that contains incremental data. If incremental data is generated during the full backup, this parameter is returned. |
Reason | String | success |
The reason why the full backup file failed to be imported. |
Examples
Sample requests
http(s)://rds.aliyuncs.com/?Action=ListUserBackupFiles
&RegionId=cn-hangzhou
&<Common request parameters>
Sample success responses
XML
format
HTTP/1.1 200 OK
Content-Type:application/xml
<ListUserBackupFilesResponse>
<RequestId>9FB29A6E-C63A-4810-B71D-AFC65FD66309</RequestId>
<Records>
<Status>BackupSuccess</Status>
<Comment>b-c8677aw89jo7********</Comment>
<EngineVersion>5.7</EngineVersion>
<OssBucket>ghjtest</OssBucket>
<BackupId>b-c8677aw89jo7********</BackupId>
<ModificationTime>1623310685000</ModificationTime>
<Retention>3</Retention>
<OssFileMetaData>{"Accept-Ranges":"bytes","Connection":"keep-alive","Content-Length":81014337,"Content-MD5":"WBKyX0RbaSVjiwINUgEuTA==","Content-Type":"application/octet-stream","Date":1623310682000,"ETag":"5812B25F445B6925638B020D52012E4C","Last-Modified":1623310648000,"Server":"AliyunOSS","x-oss-hash-crc64ecma":"5793608435727323129","x-oss-object-type":"Normal","x-oss-request-id":"60C1C15AA846BB3737811ED8","x-oss-server-time":"17","x-oss-storage-class":"Standard"}</OssFileMetaData>
<CreationTime>1623310685000</CreationTime>
<OssUrl>https://******.oss-ap-********.aliyuncs.com/backup_qp.xb</OssUrl>
<OssFileName>backup_qp.xb</OssFileName>
<RestoreSize>20</RestoreSize>
<OssFileSize>79115</OssFileSize>
<Engine>mysql</Engine>
<OssFilePath>test/backup_qp.xb</OssFilePath>
</Records>
</ListUserBackupFilesResponse>
JSON
format
HTTP/1.1 200 OK
Content-Type:application/json
{
"RequestId" : "9FB29A6E-C63A-4810-B71D-AFC65FD66309",
"Records" : [ {
"Status" : "BackupSuccess",
"Comment" : "b-c8677aw89jo7********",
"EngineVersion" : "5.7",
"OssBucket" : "ghjtest",
"BackupId" : "b-c8677aw89jo7********",
"ModificationTime" : 1623310685000,
"Retention" : 3,
"OssFileMetaData" : "{\"Accept-Ranges\":\"bytes\",\"Connection\":\"keep-alive\",\"Content-Length\":81014337,\"Content-MD5\":\"WBKyX0RbaSVjiwINUgEuTA==\",\"Content-Type\":\"application/octet-stream\",\"Date\":1623310682000,\"ETag\":\"5812B25F445B6925638B020D52012E4C\",\"Last-Modified\":1623310648000,\"Server\":\"AliyunOSS\",\"x-oss-hash-crc64ecma\":\"5793608435727323129\",\"x-oss-object-type\":\"Normal\",\"x-oss-request-id\":\"60C1C15AA846BB3737811ED8\",\"x-oss-server-time\":\"17\",\"x-oss-storage-class\":\"Standard\"}",
"CreationTime" : 1623310685000,
"OssUrl" : "https://******.oss-ap-********.aliyuncs.com/backup_qp.xb",
"OssFileName" : "backup_qp.xb",
"RestoreSize" : 20,
"OssFileSize" : 79115,
"Engine" : "mysql",
"OssFilePath" : "test/backup_qp.xb"
} ]
}
Error codes
For a list of error codes, visit the API Error Center.