DescribeBackupPolicy - - Alibaba Cloud Documentation Center

Operation description

For information about the endpoints of AnalyticDB for MySQL, see Endpoints .

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
adb:DescribeBackupPolicy	get	DBClusterLakeVersion acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}	none	none

Request parameters

Parameter	Type	Required	Description	Example
DBClusterId	string	Yes	The cluster ID. Note You can call the DescribeDBClusters operation to query the information about all AnalyticDB for MySQL clusters within a region, including cluster IDs.	am-uf6s7oa710rbu0x3b

Response parameters

Parameter	Type	Description	Example
	object
PreferredBackupPeriod	string	The cycle based on which backups are performed. If more than one day of the week is specified, the days of the week are separated by commas (,). Valid value: Monday Tuesday Wednesday Thursday Friday Saturday Sunday	Wednesday,Saturday
LogBackupRetentionPeriod	integer	The number of days for which the log backup files are retained.	7
RequestId	string	The request ID.	1AD222E9-E606-4A42-BF6D-8A4442913CEF
PreferredBackupTime	string	The data backup time. The time is in the HH:mmZ-HH:mmZ format. The time is displayed in UTC.	15:00Z-16:00Z
EnableBackupLog	string	Indicates whether log backup is enabled. Valid values: Enable Disable	true
BackupRetentionPeriod	integer	The number of days for which data backup files are retained.	7

Examples

Sample success responses

JSONformat

{
  "PreferredBackupPeriod": "Wednesday,Saturday",
  "LogBackupRetentionPeriod": 7,
  "RequestId": "1AD222E9-E606-4A42-BF6D-8A4442913CEF",
  "PreferredBackupTime": "15:00Z-16:00Z",
  "EnableBackupLog": "true",
  "BackupRetentionPeriod": 7
}

Error codes

HTTP status code	Error code	Error message	Description
404	InvalidDBCluster.NotFound	The DBClusterId provided does not exist in our records.	The specified DBClusterId parameter does not exist. Make sure that the DBClusterId value is valid.

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

Change history

Change time	Summary of changes	Operation

No change history