DescribeBackupPolicy-阿里云帮助中心

Queries the backup policy of a PolarDB instance.

Operation description

Supported engines

PolarDB MySQL Edition

Note

This API is currently available only to specific customers. If you need access, please apply through the DBS customer consultation group (DingTalk group number: 35585947).

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

dbs:DescribeBackupPolicy

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionCode	string	No	The region where the backup set is located.	cn-beijing
InstanceName	string	No	The PolarDB instance ID.	pc-2ze3nrr64c5****

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	54A63B3B-AA10-1CC3-A6BB-6CCE98D19628
Message	string	The returned message.	instanceName can not be empty.
Data	object	The backup policy details.
PreferredBackupDate	string	The backup cycle for basic backup. A 7-digit string is returned, where each digit from left to right corresponds to Monday through Sunday. 1 indicates backup is performed, and 0 indicates no backup.	1010101
PreferredBackupWindowBegin	string	The start time of the basic backup window.	23:00Z
PreferredBackupWindow	string	The basic backup window.	23:00Z-24:00Z
BackupRetentionPeriod	integer	The basic backup retention period. If the advanced backup policy is enabled, this is the longest retention period in the level-1 backup policy.	7
BackupRetentionPolicyOnClusterDeletion	string	The archive backup retention policy for deleted instances. Valid values: NONE: Do not retain LATEST: Retain the last one ALL: Retain all	LATEST
HighFrequencyBakInterval	integer	The high-frequency backup interval. For example, 120 indicates a backup every two hours. Unit: minutes.	120
BackupPriority	integer	The secondary instance backup setting. Valid values: 1: Prefer secondary instance 2: Force primary instance Note This parameter applies only to RDS SQL Server instances. For other engines, the return value is 0.	0
EnableLogBackup	integer	Indicates whether log backup is enabled. Valid values: 1: Enabled 0: Disabled	1
LogBackupRetention	integer	The log backup retention period.	7
LogBackupLocalRetentionNumber	string	The number of local log files retained.	10
EnableBackup	integer	Indicates whether backup is enabled.	1
LocalLogRetentionSpace	integer	The maximum local log space usage rate.	30
HighSpaceUsageProtection	string	Indicates whether to force log cleanup when instance space usage exceeds 80% or remaining space is less than 5 GB: Disable: Do not clean up Enable: Clean up	Enable
Category	string	Indicates whether second-level backup is enabled. Valid values: Flash: Second-level backup enabled Standard: Standard backup Note This parameter only applies to MySQL.	Standard
IncBackupInterval	integer	The high-frequency incremental backup interval.	-1
EnableIncBackup	integer	Indicates whether incremental backup is enabled.	0
BackupMethod	string	The backup method. Valid values: Physical: Physical backup Snapshot: Snapshot backup	Physical
AdvanceLogPolicies	array<object>	The log backup policy details.
	object	The policy details.
PolicyId	string	The backup policy ID.	dc13b153acc91141789122c23835****
SrcType	string	The source type of the backup policy. Valid values: db: database level1: level-1 backup level2: level-2 backup level2Cross: level-2 cross-region backup	level1
SrcRegion	string	The source region of the backup policy.	cn-beijing
DestType	string	The destination type of the backup policy. Valid values: db: database level1: level-1 backup level2: level-2 backup level2Cross: level-2 cross-region backup	level1
DestRegion	string	The destination region of the backup policy.	cn-shanghai
EnableLogBackup	integer	Reserved.	1
LogRetentionType	string	The retention type for log backups. Valid values: never: Log backups are retained permanently. delay: Log backups are retained for a specified number of days.	delay
LogRetentionValue	string	The retention period for log backups, in days.	3
FilterType	string	The filter type for the advanced policy. Valid values: crontab: recurring schedule event: event-driven schedule	crontab
FilterKey	string	The schedule type. Valid values: dayOfWeek: weekly schedule dayOfMonth: monthly schedule dayOfYear: yearly schedule backupInterval: fixed interval schedule Note: This parameter is returned only when `FilterType` is `crontab`.	dayOfWeek
FilterValue	string	The backup cycle.	1,2,3,4,5,6,7
AdvanceDataPolicies	array<object>	The data backup policy details.
	object	The policy details.
PolicyId	string	The advanced policy ID.	71930ac2e9f15e41615e10627c******
FilterType	string	The filter type for the advanced policy. Valid values: crontab: recurring schedule event: event-driven schedule	crontab
FilterKey	string	The schedule type. Valid values: dayOfWeek: weekly schedule dayOfMonth: monthly schedule dayOfYear: yearly schedule backupInterval: fixed interval schedule Note This parameter is returned only when FilterType is set to crontab.	dayOfWeek
FilterValue	string	The backup cycle.	1,2,3,4,5,6,7
DumpAction	string	The dump action. Valid values: copy: Copies the backup. move: Moves the backup.	copy
RetentionType	string	The retention type for the backup set. Valid values: never: The backup set is retained permanently. delay: The backup set is retained for a specified number of days.	delay
RetentionValue	string	The retention period in days. This parameter is valid only when RetentionType is set to delay.	7
SrcType	string	The source type of the backup policy. Valid values: db: database level1: level-1 backup level2: level-2 backup level2Cross: level-2 cross-region backup	db
SrcRegion	string	The source region of the backup policy.	cn-beijing
DestType	string	The destination type of the backup policy. Valid values: db: database level1: level-1 backup level2: level-2 backup level2Cross: level-2 cross-region backup	level1
DestRegion	string	The destination region of the backup policy.	cn-beijing
BakType	string	The backup type. Valid values: F: full backup L: log backup	F
AutoCreated	boolean	Indicates whether the backup policy is a system-generated policy. Valid values: true: The policy is system-generated. false: The policy is user-defined.	true
StorageClass	string	The data storage type.	STANDARD
AdvanceIncPolicies	array<object>	The advanced incremental backup policies.
	object
PolicyId	string	The advanced policy ID.	smp-l0bfdmlr4c***
FilterType	string	The filter type for the advanced policy. Valid values: crontab (recurring schedule) and event (event-driven schedule).	crontab
FilterKey	string	The schedule type, which is valid only when FilterType is set to crontab. Valid values: dayOfWeek (weekly schedule), dayOfMonth (monthly schedule), dayOfYear (yearly schedule), and backupInterval (fixed interval schedule).	dayOfMonth
FilterValue	string	The value of the filter.	1
DumpAction	string	The dump action. Valid values: copy and move.	Copy
RetentionType	string	The retention type. Valid values: never (retained permanently) and delay (retained for a specified number of days).	delay
RetentionValue	string	The retention period in days.	365
SrcType	string	The source type of the backup policy. Valid values: db (database), level1 (level-1 backup), level2 (level-2 backup), and level2Cross (level-2 cross-region backup).	db
SrcRegion	string	The source region of the backup policy.	cn-hangzhou
DestType	string	The destination type of the backup policy. Valid values: db (database), level1 (level-1 backup), level2 (level-2 backup), and level2Cross (level-2 cross-region backup).	db
DestRegion	string	The destination region of the backup policy.	cn-hangzhou
BakType	string	The backup type. Valid values: F (full backup) and L (log backup).	F
AutoCreated	boolean	Indicates whether the policy is system-generated.	true
PreferredNextBackupTime	string		2025-07-08T16:05Z
EnablePitrProtection	boolean
LogBackupLocalRetention	integer		7
ColdRetention	integer		30
ColdKeepPolicy	integer		1
ColdKeepCount	integer		1
ErrMessage	string	The error message.	The specified parameter %s value is not valid.
Code	string	The status code.	Success
Success	string	Indicates whether the request was successful. Valid values: true: The request was successful. false: The request failed.	true
ErrCode	string	The error code.	Success

Examples

Success response

JSON format

{
  "RequestId": "54A63B3B-AA10-1CC3-A6BB-6CCE98D19628",
  "Message": "instanceName can not be empty.",
  "Data": {
    "PreferredBackupDate": "1010101",
    "PreferredBackupWindowBegin": "23:00Z",
    "PreferredBackupWindow": "23:00Z-24:00Z",
    "BackupRetentionPeriod": 7,
    "BackupRetentionPolicyOnClusterDeletion": "LATEST",
    "HighFrequencyBakInterval": 120,
    "BackupPriority": 0,
    "EnableLogBackup": 1,
    "LogBackupRetention": 7,
    "LogBackupLocalRetentionNumber": "10",
    "EnableBackup": 1,
    "LocalLogRetentionSpace": 30,
    "HighSpaceUsageProtection": "Enable",
    "Category": "Standard",
    "IncBackupInterval": -1,
    "EnableIncBackup": 0,
    "BackupMethod": "Physical",
    "AdvanceLogPolicies": [
      {
        "PolicyId": "dc13b153acc91141789122c23835****",
        "SrcType": "level1",
        "SrcRegion": "cn-beijing",
        "DestType": "level1",
        "DestRegion": "cn-shanghai",
        "EnableLogBackup": 1,
        "LogRetentionType": "delay",
        "LogRetentionValue": "3",
        "FilterType": "crontab",
        "FilterKey": "dayOfWeek",
        "FilterValue": "1,2,3,4,5,6,7"
      }
    ],
    "AdvanceDataPolicies": [
      {
        "PolicyId": "71930ac2e9f15e41615e10627c******",
        "FilterType": "crontab",
        "FilterKey": "dayOfWeek",
        "FilterValue": "1,2,3,4,5,6,7",
        "DumpAction": "copy",
        "RetentionType": "delay",
        "RetentionValue": "7",
        "SrcType": "db",
        "SrcRegion": "cn-beijing",
        "DestType": "level1",
        "DestRegion": "cn-beijing",
        "BakType": "F",
        "AutoCreated": true,
        "StorageClass": "STANDARD"
      }
    ],
    "AdvanceIncPolicies": [
      {
        "PolicyId": "smp-l0bfdmlr4c***",
        "FilterType": "crontab",
        "FilterKey": "dayOfMonth",
        "FilterValue": "1",
        "DumpAction": "Copy",
        "RetentionType": "delay",
        "RetentionValue": "365",
        "SrcType": "db",
        "SrcRegion": "cn-hangzhou",
        "DestType": "db",
        "DestRegion": "cn-hangzhou",
        "BakType": "F",
        "AutoCreated": true
      }
    ],
    "PreferredNextBackupTime": "2025-07-08T16:05Z",
    "EnablePitrProtection": false,
    "LogBackupLocalRetention": 7,
    "ColdRetention": 30,
    "ColdKeepPolicy": 1,
    "ColdKeepCount": 1
  },
  "ErrMessage": "The specified parameter %s value is not valid.     ",
  "Code": "Success",
  "Success": "true",
  "ErrCode": "Success"
}

Error codes

HTTP status code	Error code	Error message	Description
403	Request.Forbidden	Have no Permissions

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.