Query backup settings by using DescribeBackupPolicy - ApsaraDB RDS - Alibaba Cloud - ApsaraDB RDS

Queries the backup settings of an ApsaraDB RDS instance.

Operation description

Applicable engines

ApsaraDB RDS for MySQL
ApsaraDB RDS for PostgreSQL
ApsaraDB RDS for SQL Server
ApsaraDB RDS for MariaDB

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

rds:DescribeBackupPolicy

get

*DBInstance

acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}

rds:ResourceTag
rds:ResourceTag
rds:ResourceTag
rds:ResourceTag

None

Request parameters

Parameter	Type	Required	Description	Example
DBInstanceId	string	Yes	The instance ID. You can call the DescribeDBInstances operation to obtain the ID.	rm-uf6wjk5****
BackupPolicyMode	string	No	The backup type. Valid values: DataBackupPolicy: Data backup. LogBackupPolicy: Log backup.	DataBackupPolicy
CompressType	string	No	The backup compression method. Valid values: 0: No compression. 1: zlib compression. 2: Parallel zlib compression. 4: quicklz compression with database and table restoration enabled. 8: quicklz compression without database and table restoration supported.	1
ReleasedKeepPolicy	string	No	The data retention policy for archived backups of a deleted MySQL instance. Valid values: None: Do not retain. Lastest: Retain the last one. All: Retain all.	Lastest

Response elements

Element	Type	Description	Example
	object	The response parameters.
ArchiveBackupKeepCount	string	The number of archived backups retained for a MySQL instance.	1
ArchiveBackupKeepPolicy	string	The retention period of archived backups for a MySQL instance.	ByMonth
ArchiveBackupRetentionPeriod	string	The number of days for which archived backups are retained for a MySQL instance.	365
BackupInterval	string	The backup interval. Unit: minutes. For a MySQL instance, this parameter indicates the snapshot backup frequency rather than the snapshot backup cycle. For an SQL Server instance, this parameter indicates the log backup frequency.	30
BackupLog	string	Indicates whether log backup is enabled. Valid values: Enable: Yes. Disabled: No. For an SQL Server instance: Enable is returned only when instance log backup frequency is Every 5 Minutes. Disabled is returned when instance log backup frequency is Every 30 Minutes or Same as Data Backup. Refer to the value of BackupInterval.	Enable
BackupMethod	string	The backup method for an SQL Server instance with cloud disks. Valid values: Physical: Physical backup. Snapshot: Snapshot backup.	Physical
BackupPriority	integer	The secondary node backup setting for an SQL Server Enterprise Cluster Edition instance. Valid values: 1: Prefer secondary node. 2: Force primary node. Note This parameter is returned only when SupportModifyBackupPriority is set to True.	2
BackupRetentionPeriod	integer	The number of days for which data backups are retained.	7
Category	string	Indicates whether backup within seconds is enabled for MySQL and PostgreSQL instances. Valid values: Flash: Enabled. Standard: Disabled. Note This parameter takes effect only when the BackupPolicyMode parameter is set to DataBackupPolicy.	Standard
CompressType	string	The backup compression method. Valid values: 0: No compression. 1: zlib compression. 2: Parallel zlib compression. 4: quicklz compression with database and table restoration enabled. 8: quicklz compression without database and table restoration supported.	1
EnableBackupLog	string	Indicates whether log backup is enabled. Valid values: 1: Enabled. 0: Disabled. For an SQL Server instance: 1 is returned only when instance log backup frequency is Every 5 Minutes. 0 is returned when instance log backup frequency is Every 30 Minutes or Same as Data Backup. Refer to the value of BackupInterval.	1
EnableIncrementDataBackup	boolean	Indicates whether incremental backup is enabled for an SQL Server instance. Valid values: True: Yes. False: No.	True
IncBackupInterval	integer	The interval for high-frequency incremental backups. Unit: minutes. Valid values: 60, 120, 240, 360, and 720.	120
EnablePitrProtection	boolean	Indicates whether point-in-time recovery (PITR) is enabled for a MySQL instance. PITR is an upgraded version of log backup. Valid values: True: Yes. False: No. Note For more information, see Configure a point-in-time recovery policy.	True
HighSpaceUsageProtection	string	Indicates whether binary logs are forcibly deleted when the storage usage of a MySQL instance exceeds 80% or the remaining storage is less than 5 GB. Valid values: Disable: No. Enable: Yes.	Enable
LocalLogRetentionHours	integer	The number of hours for which local binary log backups are retained for a MySQL instance.	0
LocalLogRetentionSpace	string	The maximum storage usage allowed for local binary logs of a MySQL instance.	30
LogBackupFrequency	string	The log backup frequency for an SQL Server instance. Valid values: LogInterval: Every 30 minutes. Default value: Same as the data backup cycle specified by PreferredBackupPeriod.	LogInterval
LogBackupLocalRetentionNumber	integer	The number of local binary logs retained for a MySQL instance.	60
LogBackupRetentionPeriod	integer	The number of days for which log backups are retained.	7
PitrRetentionPeriod	integer	The number of days for which point-in-time recovery is available for a MySQL instance.	7
PreferredBackupPeriod	string	The data backup cycle. Separate multiple values with commas (,). Valid values: Monday: Monday. Tuesday: Tuesday. Wednesday: Wednesday. Thursday: Thursday. Friday: Friday. Saturday: Saturday. Sunday: Sunday.	Monday,Wednesday,Friday,Sunday
PreferredBackupTime	string	The data backup time. Format: HH:mmZ-HH:mmZ (UTC).	15:00Z-16:00Z
PreferredNextBackupTime	string	The time of the next backup. Format: yyyy-MM-ddTHH:mmZ (UTC).	2018-01-19T15:15Z
ReleasedKeepPolicy	string	The data retention policy for archived backups of a deleted MySQL instance. Valid values: None: Do not retain. Lastest: Retain the last one. All: Retain all.	None
RequestId	string	The request ID.	B87E2AB3-B7C9-4394-9160-7F639F732031
SupportModifyBackupPriority	boolean	Indicates whether the secondary node backup option can be modified for an SQL Server instance. Valid values: True: Yes. False: No.	False
SupportReleasedKeep	integer	A reserved parameter.	0
SupportVolumeShadowCopy	integer	Indicates whether snapshot backup is supported for an SQL Server instance. Valid values: 1: Yes. 0: No.	1
SupportsHighFrequencyBackup	integer	Indicates whether the 5-minute log backup feature is supported for an SQL Server instance. Valid values: 0: Not supported. 1: Supported.	0
AdvancedDataPolicies	object
AdvancedDataPolicy	array<object>	The list of advanced data backup policies.
	object
StrategyId	string	The ID of the sub-backup policy.	2e4uh8kymrvssa03cfz6ja4jx
ActionType	string	The operation on this sub-policy. The current version does not return a valid value for this field. Do not rely on this field for business logic.	null
OnlyPreserveOneEachHour	boolean	Indicates whether only one data backup is retained per hour.	false
RetentionValue	integer	The number of days for which data backups are retained. This parameter is valid only when RetentionType is set to delay.	365
BakType	string	The backup type. Valid values: F: Full backup. L: Log backup (used for SQL Server).	F
FilterKey	string	The filter option. Valid values: backupInterval: Fixed interval. dayOfWeek: Fixed weekly backup.	dayOfWeek
FilterValue	string	The filter condition value for data backups. If the filter option is crontab, enter a cron expression. If FilterKey is set to backupInterval, it indicates a backup every x minutes. If FilterKey is set to dayOfWeek, it indicates a backup on a specific day of the week.	0 2 * * 1-5
DestType	string	The type of the destination storage pool.	level1
FilterType	string	The filter type. Valid values: crontab: Periodic backup.	crontab
SrcRegion	string	The region ID of the source region for data backups.	cn-beijing
OnlyPreserveOneEachDay	boolean	Indicates whether only one data backup is retained per day.	false
SrcType	string	The type of the source storage pool.	db
DestRegion	string	The region ID of the destination region for data backups.	ap-northeast-1
RetentionType	string	The retention type. Valid values: delay: Fixed retention period. never: Long-term retention (LTR).	delay
AdvancedLogPolicies	object
AdvancedLogPolicy	array<object>	The list of advanced log backup policies.
	object
StrategyId	string	The ID of the sub-backup policy.	2e4uh8kymrvssa03cfz6ja4jx
ActionType	string	The operation on this sub-policy. The current version does not return a valid value for this field. Do not rely on this field for business logic.	null
LogRetentionType	string	The retention type. Valid values: delay: Fixed retention period. never: Long-term retention (LTR).	delay
DestType	string	The type of the destination storage pool. Valid values: level2Cross: Cross-region backup. level2: Same-region backup.	level1
EnableLogBackup	integer	The flag that indicates whether log backup is enabled. The value is an integer.	1
SrcType	string	The type of the source storage pool.	db
SrcRegion	string	The region ID of the source region for log backups.	cn-beijing
LogRetentionValue	integer	The number of days for which logs are retained. This parameter is valid only when LogRetentionType is set to delay.	7
DestRegion	string	The region ID of the destination region for log backups.	ap-northeast-1
FilterKey	string	The filter option. Valid values: backupInterval: Fixed interval. dayOfWeek: Fixed weekly backup.	dayOfWeek
FilterValue	string	The filter condition value for log backups. If the filter option is crontab, enter a cron expression. If FilterKey is set to backupInterval, it indicates a backup every x minutes. If FilterKey is set to dayOfWeek, it indicates a backup on a specific day of the week.	0 2 * * 1-5
AdvancedBackupPolicyEnabled	boolean	Indicates whether the advanced backup policy is enabled.	false

Examples

Success response

JSON format

{
  "ArchiveBackupKeepCount": "1",
  "ArchiveBackupKeepPolicy": "ByMonth",
  "ArchiveBackupRetentionPeriod": "365",
  "BackupInterval": "30",
  "BackupLog": "Enable",
  "BackupMethod": "Physical",
  "BackupPriority": 2,
  "BackupRetentionPeriod": 7,
  "Category": "Standard",
  "CompressType": "1",
  "EnableBackupLog": "1",
  "EnableIncrementDataBackup": true,
  "IncBackupInterval": 120,
  "EnablePitrProtection": true,
  "HighSpaceUsageProtection": "Enable",
  "LocalLogRetentionHours": 0,
  "LocalLogRetentionSpace": "30",
  "LogBackupFrequency": "LogInterval",
  "LogBackupLocalRetentionNumber": 60,
  "LogBackupRetentionPeriod": 7,
  "PitrRetentionPeriod": 7,
  "PreferredBackupPeriod": "Monday,Wednesday,Friday,Sunday",
  "PreferredBackupTime": "15:00Z-16:00Z",
  "PreferredNextBackupTime": "2018-01-19T15:15Z",
  "ReleasedKeepPolicy": "None",
  "RequestId": "B87E2AB3-B7C9-4394-9160-7F639F732031",
  "SupportModifyBackupPriority": true,
  "SupportReleasedKeep": 0,
  "SupportVolumeShadowCopy": 1,
  "SupportsHighFrequencyBackup": 0,
  "AdvancedDataPolicies": {
    "AdvancedDataPolicy": [
      {
        "StrategyId": "2e4uh8kymrvssa03cfz6ja4jx",
        "ActionType": "null",
        "OnlyPreserveOneEachHour": false,
        "RetentionValue": 365,
        "BakType": "F",
        "FilterKey": "dayOfWeek ",
        "FilterValue": "0 2 * * 1-5",
        "DestType": "level1",
        "FilterType": "crontab",
        "SrcRegion": "cn-beijing",
        "OnlyPreserveOneEachDay": false,
        "SrcType": "db",
        "DestRegion": "ap-northeast-1",
        "RetentionType": "delay\n"
      }
    ]
  },
  "AdvancedLogPolicies": {
    "AdvancedLogPolicy": [
      {
        "StrategyId": "2e4uh8kymrvssa03cfz6ja4jx",
        "ActionType": "null",
        "LogRetentionType": "delay",
        "DestType": "level1",
        "EnableLogBackup": 1,
        "SrcType": "db",
        "SrcRegion": "cn-beijing",
        "LogRetentionValue": 7,
        "DestRegion": "ap-northeast-1",
        "FilterKey": "dayOfWeek\n",
        "FilterValue": "0 2 * * 1-5"
      }
    ]
  },
  "AdvancedBackupPolicyEnabled": false
}

Error codes

HTTP status code	Error code	Error message	Description
400	IO.Exception	IO exception, retry later.	An I/O error occurred.
400	InternalFailure	Internal failure, retry later.	The request failed. Please try again later.
400	InvalidParameter.OwnerAccount	The specified parameter OwnerAccount is not valid.	The operation failed. The value of the OwnerAccount parameter is invalid. Check the value of this parameter.
400	InvalidEngine.Malformed	Specified engine is not valid.	The database engine is invalid. Specify a valid database engine.
400	Order.ComboInstanceNotAllowOperate	A package instance is not allowed to operate independently.	A package instance is not allowed to operate independently.
400	Price.PricingPlanResultNotFound	Pricing plan price result not found.	Pricing plan price result not found.
400	Order.NoRealNameAuthentication	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.	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.
400	InsufficientAvailableQuota	Your 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.
400	CommodityServiceCalling.Exception	Failed to call commodity service.	Failed to call commodity service return.
400	RegionDissolvedEOM	Dear 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.
400	Commodity.InvalidComponent	The module you purchased is not legal, please buy it again.	The module you purchased is not legal, please buy it again.
400	RegionEndTimeDissolvedAustralia	Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.	Hello customer, this area has been abolished.
400	Price.CommoditySys	Commodity system call exception.	Commodity system call exception.
400	Pay.InsufficientBalance	Insufficient available balance.	Insufficient available balance.
400	Order.PeriodInvalid	There is a problem with the period you selected, please choose again.	There is a problem with the period you selected, please choose again.
400	pay.noCreditCard	Account not bound to credit card.	Your account is not linked to a credit card.
400	Order.InstHasUnpaidOrder	There 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.
400	noAvailablePaymentMethod	No payment method is specified for your account. We recommend that you add a payment method.	No payment method has been specified for your account. We recommend that you add a payment method.
400	BasicInfoUncompleted	Your information is incomplete. Complete your information before the operation.	Your basic information is not complete, please complete your basic information before operation.
400	Risk.RiskControlRejection	Your account is abnormal, please contact customer service for details.	Your account is abnormal, please contact customer service for details.
400	Api.NotSupport	Specified api is not supported.	The current interface does not support.
400	ContainForbiddenLabelError	There 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.
400	InvalidDBInstanceId.NotFound	The DBInstanceId provided does not exist in records.	The DBInstanceId provided does not exist.
400	InvalidInstanceLevel.DiskType	Specified instance level not support request disk type	The current instance type does not support the specified storage type.
400	InvalidParam	Sepcified 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.
400	KmsApiError	User secret key invalid.	The user key is invalid.
400	System.SaleValidateFailed	Sales expression validation system error.	A system error occurs when the sales expression is verified.
400	Abs.InvalidAccount.NotFound	account is not found.	The account does not exist.
400	SqlExecuteFailedOrTimeout	sql command execution failed or timed out:%s.	SQL command execution failed or timed out
400	ColdData.EngineVersionNotSupport	The current instance engine version not support coldDataEnabled.	The current instance engine version not support coldDataEnabled.
400	ColdData.MinorVersionNotSupport	The current instance minor version not support coldDataEnabled.	The current instance minor version not support coldDataEnabled.
400	IncorrectTargetClasscode	The current instance type does not support this operation.	This operation is not supported by the instance type.
400	InvalidConnectionString.Duplicate	Specified connection string already exists in the RDS.	The link address name is duplicate. Please reset the connection string.
400	RequiredParam.NotFound	Required input param is not found.	The required parameters are not provided.
400	Parameters.Invalid	Parameter error, please check the parameters.	Parameter error, please check the parameters.
400	BackupPolicyNotSupport	Cold 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.
400	InvalideStatus.Format	The instance status does not support this operation.	This operation is not supported in the current instance status.
400	InvalidReleasedKeepPolicy.Format	Specified Released Keep Policy is not valid.	Specified Released Keep Policy is not valid.
400	InvalidDBInstanceEngineType.Format	the DB instance engine type does not support this operation.	This operation is not supported for the database engine of the instance.
400	Pay.NoCreditCard	No credit cards.	No credit cards.
400	VpcNetworkTypeNotSupport	The vpc network type instance does not support this operation.	The vpc network type instance does not support this operation.
400	MirrorInsExists	Specified DB instance mirror ins already existed.	Specified DB instance mirror ins already existed.
400	UnsupportedClassCode	The specified DB instance class stops selling.	The specified DB instance class stops selling.
400	InvalidBackupSet	The specified database does not exist in the backup set.	The specified database does not exist in the backup set.
400	OrdTCommodityQueryError	Failed to query for product.	Failed to query product.
400	ProductInstanceReleased	The instance has been released. Please check before placing the order.	The instance has been released, please verify and place an order.
400	RegionEndTimeDissolvedIndia	The region is no longer supported.	The region is no longer supported.
500	ExternalFailure	The request processing has failed due to external service failure.	The request processing has failed due to external service failure.
500	RequestMetaDataFailed	The service request failed. Please try again later or contact service personnel.	The service request failed. Please try again later or contact service personnel.
500	InvokeProxyFailure	The request processing has failed due to service failure of rds api.	The request failed to be processed due to an RDS API failure.
403	IncorrectDBInstanceState	Current DB instance state does not support this operation.	The operation failed because the current instance status does not support this operation. Retry later.
403	OrderStatus.UnPaid	The specified db instance has unpaid order.	The instance has an unpaid order. Please pay first and try again.
403	InvalidReduceDiskSize	The 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
403	CloudSSDNotSupport	Cloud ssd does not support this operation, please upgrade to essd.	This operation is not supported for SSDs. Upgrade to ESSDs.
403	InvalidUserOperatorPermission	The user permission does not support this operation.	The user is not authorized to perform this operation.
403	InvalidVswitchId	Specified conn vswitch id is not valid.	The specified VSwitchId is invalid or empty.
403	IncorrectMinorVersion	Current engine minor version does not support operations.	This operation is not supported for the current minor engine version.
403	OperationDenied.ZoneResource	There is no available zone for inventory.	There is no available zone for inventory.
403	NotInFlowController	Sorry,no permission.	Sorry,no permission.
403	InvalidKmsKey	Kms key is disabled.	The specified KMS key is disabled.
403	InvalidInstanceLevel.Malformed	Current DB instance level does not support this operation.	The specified database instance type does not support this operation.
404	InvalidDBInstance.NotFound	Specified instance does not exist or not support.	The RDS instance cannot be found, is deleted, or does not support the operation.
404	InvalidDBInstanceName.NotFound	Invalid DBInstanceId NotFound.	The instance ID cannot be found.
404	InvalidClusterKms	The current instance does not authorized to access the Key Management Service.	The instance does not have permissions to access Key Management Service (KMS).
404	Request.NotFound	The requested resource is not available.	The requested resources are unavailable.
404	HostInfo.NotFound	The specified host info is not found.	The specified host information does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.