All Products
Search
Document Center

ApsaraDB RDS:DescribeBackups

Last Updated:Sep 27, 2024

Queries the data backup files of an ApsaraDB RDS instance.

Operation description

Supported database engines

  • RDS MySQL
  • RDS PostgreSQL
  • RDS SQL Server
  • RDS MariaDB

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

Request parameters

ParameterTypeRequiredDescriptionExample
DBInstanceIdstringYes

The instance ID. You can call the DescribeDBInstances operation to query the instance ID.

rm-uf6wjk5xxxxxxx
BackupIdstringNo

The ID of the backup set.

327329803
BackupStatusstringNo

The status of the backup set. Valid values:

  • Success
  • Failed
Success
BackupModestringNo

The backup mode. Valid values:

  • Automated
  • Manual
Automated
StartTimestringNo

The beginning of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mmZ format. The time must be in UTC.

2011-06-01T16:00Z
EndTimestringNo

The end of the time range to query. The end time must be later than the start time. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mmZ format. The time must be in UTC.

Note We recommend that you specify a time range that is as short as possible to avoid timeout.
2011-06-15T16:00Z
PageSizeintegerNo

The number of entries per page. Valid values:

  • 30
  • 50
  • 100

Default value: 30.

30
PageNumberintegerNo

The number of the page to return. Valid values: any non-zero positive integer.

Default value: 1.

1
BackupTypestringNo

The backup type. Valid values:

  • FullBackup: full backup
  • IncrementalBackup: incremental backup
FullBackup

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The ID of the request.

1A6D328C-84B8-40DC-BF49-6C73984D7494
TotalEcsSnapshotSizelong

The size of the snapshot chain of the instance. Unit: bytes.

0
PageRecordCountstring

The number of backup sets on the current page.

30
TotalRecordCountstring

The total number of entries returned.

100
PageNumberstring

The page number of the returned page.

1
Itemsarray<object>

The returned backup sets.

Backupobject

The details of the returned backup sets.

StorageClassstring

The storage class of the backup set. Valid values:

  • 0: regular storage
  • 1: archive storage
0
Encryptionstring

The encryption information about the backup set.

{}
BackupStatusstring

The state of the backup set.

Success
StoreStatusstring

Indicates whether the backup set can be deleted. Valid values:

  • Enabled: The backup set can be deleted.
  • Disabled: The backup set cannot be deleted.
Disabled
ConsistentTimelong

The point in time at which the data in the backup set is consistent. The return value of this parameter is a timestamp.

Note If the instance runs MySQL 5.6, a timestamp is returned. Otherwise, the value 0 is returned.
1576506856
BackupTypestring

The backup type of the backup set. Valid values:

  • FullBackup
  • IncrementalBackup
FullBackup
CopyOnlyBackupstring

The backup mode of the backup set. Valid values:

  • 0: the standard mode. This mode supports full backups and incremental backups.
  • 1: the copy-only mode. This mode supports only full backups.
Note This parameter is returned only when the instance runs SQL Server.
0
BackupEndTimestring

The end time of the backup task. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mmZ format. The time is displayed in UTC.

2019-02-13T12:20:00Z
MetaStatusstring

The status of the backup set that is used to restore individual databases or tables. Valid values:

  • OK: The data backup file is normal.
  • LARGE: The data backup file contains an abnormally large number of tables. It cannot be used to restore individual databases or tables.
  • EMPTY: The data backup file is generated from a failed backup task.
Note If an empty string is returned, the data backup file cannot be used to restore individual databases or tables.
OK
BackupInitiatorstring

The initiator of the backup task. Valid values:

  • System
  • User
System
BackupIntranetDownloadURLstring

The URL that is used to download the backup set over an internal network. If the backup set cannot be downloaded, null is returned.

Note For example, if BackupMethod of an ApsaraDB RDS for SQL Server instance is set to Snapshot, a null string is returned.
http://rdsbak-hz-v3.oss-cn-hangzhou-internal.aliyuncs.com/xxxxx
BackupMethodstring

The method that is used to generate the backup set. Valid values:

  • Logical: logical backup
  • Physical: physical backup
  • Snapshot: snapshot backup
Physical
BackupStartTimestring

The start time of the backup. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mmZ format. The time is displayed in UTC.

2019-02-03T12:20:00Z
BackupDownloadURLstring

The URL that is used to download the backup set over the Internet. If the backup set cannot be downloaded, null is returned.

Note For example, if BackupMethod of an ApsaraDB RDS for SQL Server instance is set to Snapshot, a null string is returned.
http://rdsbak-hz-v3.oss-cn-hangzhou.aliyuncs.com/xxxxx
IsAvailinteger

Indicates whether the backup set is available. Valid values:

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

The ID of the backup set.

321020562
HostInstanceIDstring

The ID of the instance that generates the backup set. This parameter is used to indicate whether the instance that generates the backup set is a primary instance or a secondary instance.

5882781
BackupSizelong

The size of the data backup file. Unit: bytes.

2167808
BackupModestring

The backup mode of the backup set. Valid values:

  • Automated
  • Manual
Automated
DBInstanceIdstring

The instance ID.

rm-uf6wjk5xxxxxxx
Checksumstring

The checksum. The value of this parameter is calculated by using the CRC64 algorithm.

1835830439**********
BackupDownloadLinkByDBarray<object>

An array consisting of URLs from which you can download backup sets of individual databases.

BackupDownloadLinkByDBobject
DataBasestring

The name of the database.

dbs
Enginestring

The type of the database engine. Valid values:

  • MySQL
  • SQLServer
  • PostgreSQL
  • MariaDB
MySQL
EngineVersionstring

The version of the database engine.

8.0

Examples

Sample success responses

JSONformat

{
  "RequestId": "1A6D328C-84B8-40DC-BF49-6C73984D7494",
  "TotalEcsSnapshotSize": 0,
  "PageRecordCount": "30",
  "TotalRecordCount": "100",
  "PageNumber": "1",
  "Items": {
    "Backup": [
      {
        "StorageClass": "0",
        "Encryption": "{}",
        "BackupStatus": "Success",
        "StoreStatus": "Disabled",
        "ConsistentTime": 1576506856,
        "BackupType": "FullBackup",
        "CopyOnlyBackup": "0",
        "BackupEndTime": "2019-02-13T12:20:00Z",
        "MetaStatus": "OK",
        "BackupInitiator": "System",
        "BackupIntranetDownloadURL": "http://rdsbak-hz-v3.oss-cn-hangzhou-internal.aliyuncs.com/xxxxx",
        "BackupMethod": "Physical",
        "BackupStartTime": "2019-02-03T12:20:00Z",
        "BackupDownloadURL": "http://rdsbak-hz-v3.oss-cn-hangzhou.aliyuncs.com/xxxxx",
        "IsAvail": 1,
        "BackupId": "321020562",
        "HostInstanceID": "5882781",
        "BackupSize": 2167808,
        "BackupMode": "Automated",
        "DBInstanceId": "rm-uf6wjk5xxxxxxx",
        "Checksum": "1835830439**********",
        "BackupDownloadLinkByDB": {
          "BackupDownloadLinkByDB": [
            {
              "IntranetDownloadLink": "https://cn-hangzhou-internal.bak.rds.aliyuncs.com/custins53664665/hins18676859_2021072909473127987849.zip?Expires=*****&dbList=tb1",
              "DataBase": "dbs",
              "DownloadLink": "https://cn-hangzhou.bak.rds.aliyuncs.com/custins53664665/hins18676859_2021072909473127987849.zip?Expires=*****&dbList=tb1"
            }
          ]
        },
        "Engine": "MySQL",
        "EngineVersion": "8.0"
      }
    ]
  }
}

Error codes

HTTP status codeError codeError messageDescription
400InvalidRestoreTime.MalformedThe requested restoreTime param is invalid, or the requested restoreTime is not within the scope of the instance backup.-
400InvalidPageNumbers.MalformedSpecified page number is not valid.The page number cannot be found.
400InvalidStartTime.FormatSpecified start time is not valid.The start time is invalid.
400InvalidEndTime.FormatSpecified end time is not valid.The end time is invalid. Check the end time.
400InvalidParameterCombinationThe end time must be greater than the start timeThe end time must be later than the start time.
400InvalidDBinstanceClass.ValueNotSupportedThe specified parameter DBinstanceClass is invalid.The specified parameter DBinstanceClass is invalid.
400InvalidBackupSetLocation.FormatSpecified backup set location is not valid.-
400Order.ComboInstanceNotAllowOperateA package instance is not allowed to operate independently.A package instance is not allowed to operate independently.
400Price.PricingPlanResultNotFoundPricing plan price result not found.Pricing plan price result not found.
400Order.NoRealNameAuthenticationYou have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.
400InsufficientAvailableQuotaYour account quota limit is less than 0, please recharge before trying to purchase.Your account available limit is less than 0, please recharge before trying to purchase.
400CommodityServiceCalling.ExceptionFailed to call commodity service.Failed to call commodity service return.
400RegionDissolvedEOMDear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.
400Commodity.InvalidComponentThe module you purchased is not legal, please buy it again.The module you purchased is not legal, please buy it again.
400RegionEndTimeDissolvedIndiaCloud services in the India (Mumbai) region will be discontinued. Set the validity date to July 15, 2024 or earlier than July 15, 2024.Hello customer, this area has been abolished.
400RegionEndTimeDissolvedAustraliaCloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.
400Price.CommoditySysCommodity system call exception.Commodity system call exception.
400Pay.InsufficientBalanceInsufficient available balance.Insufficient available balance.
400Order.PeriodInvalidThere is a problem with the period you selected, please choose again.There is a problem with the period you selected, please choose again.
400pay.noCreditCardAccount not bound to credit card.-
400Order.InstHasUnpaidOrderThere is an unpaid order for the service you have purchased. Please pay or void it before placing the order.There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.
400noAvailablePaymentMethodNo payment method is specified for your account. We recommend that you add a payment method.-
400BasicInfoUncompletedYour information is incomplete. Complete your information before the operation.Your basic information is not complete, please complete your basic information before operation.
400Risk.RiskControlRejectionYour account is abnormal, please contact customer service for details.Your account is abnormal, please contact customer service for details.
400BasicInfoUncompletedYour information is incomplete, Complete your information before the operation.-
400Api.NotSupportSpecified api is not supported.The current interface does not support.
400ContainForbiddenLabelErrorThere is a label that prohibits placing orders. Please contact your distributor for assistance.You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.
400InvalidDBInstanceId.NotFoundThe DBInstanceId provided does not exist in records.The DBInstanceId provided does not exist.
400InvalidInstanceLevel.DiskTypeSpecified instance level not support request disk typeThe current instance type does not support the specified storage type.
400InvalidParamSepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.
400KmsApiErrorUser secret key invalid.The user key is invalid.
400System.SaleValidateFailedSales expression validation system error.A system error occurs when the sales expression is verified.
400Abs.InvalidAccount.NotFoundaccount is not found.The account does not exist.
400SqlExecuteFailedOrTimeoutsql command execution failed or timed out:%s.SQL command execution failed or timed out
400ColdData.EngineVersionNotSupportThe current instance engine version not support coldDataEnabled.The current instance engine version not support coldDataEnabled.
400ColdData.MinorVersionNotSupportThe current instance minor version not support coldDataEnabled.The current instance minor version not support coldDataEnabled.
400IncorrectTargetClasscodeThe current instance type does not support this operation.This operation is not supported by the instance type.
400InvalidConnectionString.DuplicateSpecified connection string already exists in the RDS.The link address name is duplicate. Please reset the connection string.
400RequiredParam.NotFoundRequired input param is not found.-
400Parameters.InvalidParameter error, please check the parameters.Parameter error, please check the parameters.
400BackupPolicyNotSupportCold Data won't open with CrossBackup or Flash Backup, please check Backup Policy.Cold Data won't open with CrossBackup or Flash Backup, please check Backup Policy.
400InvalideStatus.FormatThe instance status does not support this operation.-
400InvalidReleasedKeepPolicy.FormatSpecified Released Keep Policy is not valid.Specified Released Keep Policy is not valid.
400InvalidDBInstanceEngineType.Formatthe DB instance engine type does not support this operation.This operation is not supported for the database engine of the instance.
400Pay.NoCreditCardNo credit cards.No credit cards.
400VpcNetworkTypeNotSupportThe vpc network type instance does not support this operation.The vpc network type instance does not support this operation.
400MirrorInsExistsSpecified DB instance mirror ins already existed.Specified DB instance mirror ins already existed.
400UnsupportedClassCodeThe specified DB instance class stops selling.The specified DB instance class stops selling.
400InvalidBackupSetThe specified database does not exist in the backup set.The specified database does not exist in the backup set.
400OrdTCommodityQueryErrorFailed to query for product.Failed to query product.
400ProductInstanceReleasedThe instance has been released. Please check before placing the order.The instance has been released, please verify and place an order.
403InvalidMaxRecordsPerPage.MalformedSpecified record number is not valid.-
403IncorrectDBInstanceStateCurrent DB instance state does not support this operation.-
403OrderStatus.UnPaidThe specified db instance has unpaid order.The instance has an unpaid order. Please pay first and try again.
403InvalidReduceDiskSizeThe storage capacity after the scale-down must be larger than the used amount.The scale-in target capacity cannot be less than the current storage space usage
403CloudSSDNotSupportCloud ssd does not support this operation, please upgrade to essd.-
403InvalidUserOperatorPermissionThe user permission does not support this operation.The user is not authorized to perform this operation.
403InvalidVswitchIdSpecified conn vswitch id is not valid.-
403IncorrectMinorVersionCurrent engine minor version does not support operations.This operation is not supported for the current minor engine version.
403OperationDenied.ZoneResourceThere is no available zone for inventory.There is no available zone for inventory.
403NotInFlowControllerSorry,no permission.Sorry,no permission.
403InvalidKmsKeyKms key is disabled.-
403InvalidInstanceLevel.MalformedCurrent DB instance level does not support this operation.The specified database instance type does not support this operation.
404InvalidDBInstanceName.NotFoundThe database instance does not exist.The name of the RDS instance cannot be found. Check the name of the RDS instance.
404InvalidDBInstance.NotFoundThe specified instance does not exist or is not supported.The RDS instance cannot be found. Check the ID or name of the RDS instance.
404Request.NotFoundThe requested resource is not available.The requested resources are unavailable.
404InvalidClusterKmsThe current instance does not authorized to access the Key Management Service.The instance does not have permissions to access Key Management Service (KMS).
404HostInfo.NotFoundThe specified host info is not found.-
500ExternalFailureThe request processing has failed due to external service failure.The request processing has failed due to external service failure.
500RequestMetaDataFailedThe service request failed. Please try again later or contact service personnel.The service request failed. Please try again later or contact service personnel.
500InvokeProxyFailureThe request processing has failed due to service failure of rds api.The request failed to be processed due to an RDS API failure.

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

Change history

Change timeSummary of changesOperation
2024-08-13The Error code has changed. The request parameters of the API has changedView Change Details
2024-08-06The Error code has changed. The response structure of the API has changedView Change Details
2024-07-05The Error code has changedView Change Details
2024-07-02The Error code has changed. The response structure of the API has changedView Change Details
2021-10-21The response structure of the API has changedView Change Details