DescribeBackupPolicy - PolarDB - Alibaba Cloud Documentation Center

Queries the details of a backup policy by calling the DescribeBackupPolicy operation.

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

drds:DescribeBackupPolicy

get

*instance

acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/*

None

Request parameters

Parameter	Type	Required	Description	Example
DrdsInstanceId	string	Yes	The instance ID.	drdshbga71nn****

Response elements

Element	Type	Description	Example
	object
Success	boolean	Indicates whether the operation is successful. Valid values: true: The operation is successful. false: The operation failed.	true
RequestId	string	The request ID.	8FAF3989-79CD-4A67-8FFD-97899B64SD5T
BackupPolicyDO	object	The details of the backup policy.
BackupDbName	string	This API does not return a value.	null
LogBackupRetentionPeriod	integer	The number of days for which log backups are retained.	10
DataBackupRetentionPeriod	integer	The retention period of data backups. Unit: days.	10
BackupType	string	The backup type. Valid values: manual: manual backup. auto: automatic backup.	auto
BackupLevel	string	The backup level. Valid values: db: database level. instance: instance level.	db
LocalLogRetentionHours	integer	This API does not return a value.	0
HighSpaceUsageProtection	integer	This API does not return a value.
GmtModified	integer	This API does not return a value.	0
BackupRetentionPeriod	integer	The number of days for which backups are retained.	8
BackupPolicyMode	string	The backup policy mode. Valid values: DataBackupPolicy: data backup policy. LogBackupPolicy: log backup policy.	DataBackupPolicy
PreferredBackupPeriod	string	The backup cycle. You can specify multiple backup cycles separated by commas (,). Valid values: 1: Sunday 2: Monday 3: Tuesday 4: Wednesday 5: Thursday 6: Friday 7: Saturday	2
LocalLogRetentionSpace	integer	This API does not return a value.	0
BackupAppName	string	This API does not return a value.	null
PreferredBackupTime	string	The backup time range in UTC.	22:00:00-23:00:00
GmtCreate	integer	This API does not return a value.	0
BackupMode	string	The backup method. Valid values: logic: logical backup. phy: fast backup.	phy
BackupLog	string	Indicates whether backup logging is enabled. Valid values: 1: enabled. 0: disabled.	1
NextBackupActuallyTime	string	This API does not return a value.	null

Examples

Success response

JSON format

{
  "Success": true,
  "RequestId": "8FAF3989-79CD-4A67-8FFD-97899B64SD5T",
  "BackupPolicyDO": {
    "BackupDbName": "null",
    "LogBackupRetentionPeriod": 10,
    "DataBackupRetentionPeriod": 10,
    "BackupType": "auto",
    "BackupLevel": "db",
    "LocalLogRetentionHours": 0,
    "HighSpaceUsageProtection": 0,
    "GmtModified": 0,
    "BackupRetentionPeriod": 8,
    "BackupPolicyMode": "DataBackupPolicy",
    "PreferredBackupPeriod": "2",
    "LocalLogRetentionSpace": 0,
    "BackupAppName": "null",
    "PreferredBackupTime": "22:00:00-23:00:00",
    "GmtCreate": 0,
    "BackupMode": "phy",
    "BackupLog": "1",
    "NextBackupActuallyTime": "null"
  }
}

Error codes

HTTP status code	Error code	Error message	Description
500	InternalError	The request processing has failed due to some unknown error.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.