All Products
Search
Document Center

ApsaraDB RDS:DescribeBackupPolicy

Last Updated:Apr 08, 2024

Queries the backup settings of an instance.

Operation description

Supported database engines

  • MySQL
  • PostgreSQL
  • SQL Server
  • 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:DescribeBackupPolicyREAD
  • DBInstance
    acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}
  • rds:ResourceTag
none

Request parameters

ParameterTypeRequiredDescriptionExample
DBInstanceIdstringYes

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

rm-uf6wjk5xxxxxxx
BackupPolicyModestringNo

The backup type. Valid values:

  • DataBackupPolicy: data backup
  • LogBackupPolicy: log backup
DataBackupPolicy
CompressTypestringNo

The method that is used to compress backup data. Valid values:

  • 0: Backup data is not compressed.
  • 1: Backup data is compressed by using zlib.
  • 2: Backup data is compressed by using zlib that invokes more than one thread in parallel for each backup.
  • 4: Backup data is compressed by using QuickLZ and can be used to restore individual databases or tables.
  • 8: Backup data is compressed by using QuickLZ but cannot be used to restore individual databases or tables.
1
ReleasedKeepPolicystringNo

The policy that is used to retain archived backup files if the instance is released. Valid values:

  • None: No archived backup files are retained.
  • Lastest: Only the last archived backup file is retained.
  • All: All archived backup files are retained.
Lastest

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

LogBackupRetentionPeriodinteger

The number of days for which log backup files are retained.

7
ArchiveBackupKeepPolicystring

The cycle based on which archived backup files are retained.

ByMonth
ArchiveBackupKeepCountstring

The number of archived backup files that are retained.

1
LocalLogRetentionHoursinteger

The number of hours for which log backup files are retained on the instance.

0
BackupRetentionPeriodinteger

The number of days for which data backup files are retained.

7
RequestIdstring

The ID of the request.

B87E2AB3-B7C9-4394-9160-7F639F732031
PreferredBackupPeriodstring

The cycle based on which you want to perform a backup. Separate multiple values with commas (,). Valid values:

  • Monday
  • Tuesday
  • Wednesday
  • Thursday
  • Friday
  • Saturday
  • Sunday
Monday,Wednesday,Friday,Sunday
CompressTypestring

The method that is used to compress backup data. Valid values:

  • 0: Backup data is not compressed.
  • 1: Backup data is compressed by using zlib.
  • 2: Backup data is compressed by using zlib that invokes more than one thread in parallel for each backup.
  • 4: Backup data is compressed by using QuickLZ and can be used to restore individual databases or tables.
  • 8: Backup data is compressed by using QuickLZ but cannot be used to restore individual databases or tables.
1
SupportReleasedKeepinteger

A reserved parameter.

0
LocalLogRetentionSpacestring

The maximum storage usage that is allowed for log files on the instance.

30
SupportVolumeShadowCopyinteger

Indicates whether the instance supports snapshot backups. Valid values:

  • 1: The instance supports snapshot backups.
  • 0: The instance does not support snapshot backups.
Note This parameter is returned only when the instance runs SQL Server.
1
BackupMethodstring

The backup method of the instance. Valid values:

  • Physical: physical backup
  • Snapshot: snapshot backup
Note This parameter is returned only when the instance runs SQL Server and uses cloud disks.
Physical
LogBackupFrequencystring

The backup frequency of logs. Valid values:

  • LogInterval: Log backups are performed every 30 minutes.
  • Default value: same as the value of the PreferredBackupPeriod parameter.
Note This parameter is returned only when the instance runs SQL Server.
LogInterval
PreferredNextBackupTimestring

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

2018-01-19T15:15Z
HighSpaceUsageProtectionstring

Indicates whether the log backup deletion feature is enabled. If the disk usage exceeds 80% or the remaining disk space is less than 5 GB on the instance, this feature deletes binary log files. Valid values:

  • Disable
  • Enable
Enable
ArchiveBackupRetentionPeriodstring

The number of days for which archived backup files are retained.

365
BackupIntervalstring

The backup interval. Unit: minutes.

  • If the instance runs MySQL, the interval is the same as the value of the Snapshot Backup Start Time parameter rather than the Snapshot Backup Period parameter in the ApsaraDB RDS console. For more information, see Back up an ApsaraDB RDS for MySQL instance.
  • If the instance runs SQL Server, the interval is the same as the log backup frequency.
30
ReleasedKeepPolicystring

The policy that is used to retain archived backup files if the instance is released. Valid values:

  • None: No archived backup files are retained.
  • Lastest: Only the last archived backup file is retained.
  • All: All archived backup files are retained.
None
PreferredBackupTimestring

The time when a data backup is performed. The time follows the ISO 8601 standard in the HH:mmZ-HH:mmZ format. The time is displayed in UTC.

15:00Z-16:00Z
LogBackupLocalRetentionNumberinteger

The number of binary log files that you want to retain on the instance.

60
Categorystring

Indicates whether to enable the single-digit second backup feature. This feature allows ApsaraDB RDS to complete a backup within single-digit seconds. Valid values:

  • Flash: The single-digit second backup feature is enabled.
  • Standard: The single-digit second backup feature is disabled.
Note This parameter takes effect only when you set the BackupPolicyMode parameter to DataBackupPolicy.
Standard
EnableBackupLogstring

Indicates whether the log backup feature is enabled. Valid values:

  • 1: enabled
  • 0: disabled
1
BackupLogstring

Indicates whether the log backup feature is enabled. Valid values:

  • Enable
  • Disabled
Enable
EnableIncrementDataBackupboolean

Indicates whether incremental backup is enabled. Valid values:

  • True: Incremental backup is enabled.
  • False: Incremental backup is disabled.
True
SupportModifyBackupPriorityboolean

Indicates whether the backup settings of a secondary instance can be modified. Valid values:

  • True
  • False
False
BackupPriorityinteger

The backup settings of the secondary instance. Valid values:

  • 1: Secondary instance preferred
  • 2: Primary instance preferred
Note This parameter is available only for instances that run SQL Server on RDS Cluster Edition. This parameter is returned only when SupportModifyBackupPriority is set to True.
2
EnablePitrProtectionboolean

Indicates whether the point-in-time restoration (PITR) feature is enabled. The PITR feature is an enhancement of the log backup feature. Valid values:

  • True
  • False
Note This parameter is returned only when the instance runs MySQL. For more information, see Configure the PITR feature.
True
PitrRetentionPeriodinteger

The number of days during which you can restore data of the instance to any point in time.

7

Examples

Sample success responses

JSONformat

{
  "LogBackupRetentionPeriod": 7,
  "ArchiveBackupKeepPolicy": "ByMonth",
  "ArchiveBackupKeepCount": "1",
  "LocalLogRetentionHours": 0,
  "BackupRetentionPeriod": 7,
  "RequestId": "B87E2AB3-B7C9-4394-9160-7F639F732031",
  "PreferredBackupPeriod": "Monday,Wednesday,Friday,Sunday",
  "CompressType": "1",
  "SupportReleasedKeep": 0,
  "LocalLogRetentionSpace": "30",
  "SupportVolumeShadowCopy": 1,
  "BackupMethod": "Physical",
  "LogBackupFrequency": "LogInterval",
  "PreferredNextBackupTime": "2018-01-19T15:15Z",
  "HighSpaceUsageProtection": "Enable",
  "ArchiveBackupRetentionPeriod": "365",
  "BackupInterval": "30",
  "ReleasedKeepPolicy": "None",
  "PreferredBackupTime": "15:00Z-16:00Z",
  "LogBackupLocalRetentionNumber": 60,
  "Category": "Standard",
  "EnableBackupLog": "1",
  "BackupLog": "Enable",
  "EnableIncrementDataBackup": true,
  "SupportModifyBackupPriority": true,
  "BackupPriority": 2,
  "EnablePitrProtection": true,
  "PitrRetentionPeriod": 7
}

Error codes

HTTP status codeError codeError messageDescription
400IO.ExceptionIO exception, retry later.An I/O error occurred.
400InternalFailureInternal failure, retry later.The request failed. Please try again later.
400InvalidParameter.OwnerAccountThe specified parameter OwnerAccount is not valid.The operation failed. The value of the OwnerAccount parameter is invalid. Check the value of this parameter.
400InvalidEngine.MalformedSpecified engine is not valid.The database engine is invalid. Specify a valid database engine.
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 user center 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.Cloud services in the India (Mumbai) region will be discontinued. Set the validity date to July 15, 2024 or earlier than July 15, 2024.
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.
403IncorrectDBInstanceStateCurrent DB instance state does not support this operation.-
404InvalidDBInstance.NotFoundSpecified instance does not exist or not support.The RDS instance cannot be found, is deleted, or does not support the operation.
404InvalidDBInstanceName.NotFoundInvalid DBInstanceId NotFound.The instance ID cannot be found.

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

Change history

Change timeSummary of changesOperation
2024-01-31The Error code has changed. The response structure of the API has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400
    delete Error Codes: 403
    delete Error Codes: 404
Output ParametersThe response structure of the API has changed.
2023-06-29The Error code has changed. The response structure of the API has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400
    delete Error Codes: 403
    delete Error Codes: 404
Output ParametersThe response structure of the API has changed.
2022-06-24API Description Update. The Error code has changedsee changesets
Change itemChange content
API DescriptionAPI Description Update.
Error CodesThe Error code has changed.
    delete Error Codes: 400
    delete Error Codes: 404