All Products
Search

This Product

    ApsaraDB RDS:ListUserBackupFiles

    Document Center

    ApsaraDB RDS:ListUserBackupFiles

    Last Updated:Apr 17, 2024

    Queries the details about the full backup files that are imported into an instance.

    Operation description

    Supported database engines

    • MySQL

    Feature description

    • 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 this 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

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

    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
    rds:DescribeUserBackupFilesRead
    • DBInstance
      acs:rds:{#regionId}:{#accountId}:dbinstance/*
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    StatusstringNo

    The status of the full backup file. Valid values:

    • Importing: The full backup file is being imported.
    • Failed: The full backup file fails to be imported.
    • CheckSucccess: The full backup file passes the check.
    • BackupSuccess: The full backup file is imported.
    • Deleted: The full backup file is deleted.
    		CheckSuccess
    RegionIdstringYes

    The ID of the region. You can call the DescribeRegions operation to query the most recent region list.

    		cn-hangzhou
    CommentstringNo

    The description of the full backup file.

    Note The system implements a fuzzy match based on the value of this parameter.
    		BackupTest
    BackupIdstringNo

    The ID of the full backup file.

    		b-kwwvr7v8t7of********
    OssUrlstringNo

    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.

    		https://******.oss-ap-********.aliyuncs.com/backup_qp.xb
    TagsstringNo

    The tag that is added to the full backup file.

    		key1:value1
    ResourceGroupIdstringNo

    The resource group ID. You can call the DescribeDBInstanceAttribute to query the resource group ID.

    		rg-acfmy*****

    Response parameters

    ParameterTypeDescriptionExample
    object

    The response parameters.

    RequestIdstring

    The ID of the request.

    		AD67C22F-64F3-4448-A9A8-D1606D242879
    Recordsobject []

    The information about the full backup files.

    Statusstring

    The status of the full backup file. Valid values:

    • Importing: The full backup file is being imported.
    • Failed: The full backup file fails to be imported.
    • CheckSucccess: The full backup file passes the check.
    • BackupSuccess: The full backup file is imported.
    • Deleted: The full backup file is deleted.
    		BackupSuccess
    CreationTimestring

    The time when the system started to import the full backup file. The value is a UNIX timestamp. Unit: milliseconds.

    		1623231084000
    FinishTimestring

    The time when the full backup file is successfully imported. The value is a UNIX timestamp. Unit: milliseconds.

    		1623231750000
    Commentstring

    The description of the full backup file.

    		BackupTest
    OssFilePathstring

    The path of the full backup file that is stored as an object in an OSS bucket.

    		test/backup_qp.xb
    OssBucketstring

    The name of the OSS bucket in which the full backup file is stored as an object.

    		BackupTest
    ModificationTimestring

    The time when the full backup file is successfully imported. The value is a UNIX timestamp. Unit: milliseconds.

    		1623231750000
    OssFileSizelong

    The size of the full backup file that is stored as an object in an OSS bucket. Unit: KB.

    		79115
    OssFileNamestring

    The name of the full backup file that is stored as an object in an OSS bucket.

    		backup_qp.xb
    EngineVersionstring

    The database engine version.

    		5.7
    BackupIdstring

    The ID of the full backup file.

    		b-kwwvr7v8t7of********
    RestoreSizestring

    The amount of storage that is required to restore the data of the full backup file. Unit: GB.

    		20
    ZoneIdstring

    The zone ID of the full backup file.

    		cn-hangzhou-b
    Retentioninteger

    The retention period of the full backup file. Unit: days.

    		3
    Enginestring

    The database engine of the instance.

    		mysql
    OssUrlstring

    The URL to download the full backup file from the OSS bucket.

    		https://******.oss-ap-********.aliyuncs.com/backup_qp.xb
    OssFileMetaDatastring

    The metadata of the full backup file. For more information, see Manage object metadata.

    		{\"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\"}
    BinlogInfostring

    The information about the binary log file that contains incremental data. If incremental data is generated during the full backup, this parameter is returned.

    		{\"binlogPosition\":\"154\",\"binlogFile\":\"0.000002\"}
    Reasonstring

    The reason why the full backup file failed to be imported.

    		success

    Examples

    Sample success responses

    JSONformat

    {
  "RequestId": "AD67C22F-64F3-4448-A9A8-D1606D242879",
  "Records": [
    {
      "Status": "BackupSuccess",
      "CreationTime": "1623231084000",
      "FinishTime": "1623231750000",
      "Comment": "BackupTest",
      "OssFilePath": "test/backup_qp.xb",
      "OssBucket": "BackupTest",
      "ModificationTime": "1623231750000",
      "OssFileSize": 79115,
      "OssFileName": "backup_qp.xb",
      "EngineVersion": "5.7",
      "BackupId": "b-kwwvr7v8t7of********",
      "RestoreSize": "20",
      "ZoneId": "cn-hangzhou-b",
      "Retention": 3,
      "Engine": "mysql",
      "OssUrl": "https://******.oss-ap-********.aliyuncs.com/backup_qp.xb",
      "OssFileMetaData": "{\\\"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\\\"}",
      "BinlogInfo": "{\\\"binlogPosition\\\":\\\"154\\\",\\\"binlogFile\\\":\\\"0.000002\\\"}",
      "Reason": "success"
    }
  ]
}

    Error codes

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

    Change history

    Change timeSummary of changesOperation
    2023-07-25The request parameters of the API has changedsee changesets
    Change itemChange content
    Input ParametersThe request parameters of the API has changed.
      Added Input Parameters: ResourceGroupId
    2022-06-23API Description Updatesee changesets
    Change itemChange content
    API DescriptionAPI Description Update.