RDS

Products

RDS

Documentation > OpenAPI & SDK > RDS > describeBackupPolicy

describeBackupPolicy

Description

View RDS instance backup policy. The supported backup policies differ based on different database type. See the detailed instructions in return parameters

Request Method

GET

Request Address

https://rds.jdcloud-api.com/v1/regions/{regionId}/instances/{instanceId}:describeBackupPolicy

Name Type Required or Not Default Description
regionId String True Region code, see the value range in Table of Comparisons of Regions and Availability Zones
instanceId String True RDS instance ID, the unique identifier of one RDS instance

Request Parameter

None

Return Parameter

Name Type Description
result Result

Result

Name Type Description
startWindow String Automatic backup start time window, with the range of 00:00-23:59, with the time range tolerance shall not be less than 30 minutes.
For instance: 00:00-01:00, representing that the database is backed up automatically from 00:00 to 01:00, and the backup completion time is related to the instance size, which is not certainly within the time range
retentionPeriod Integer Automatic backup reservation period, unit: days, the default is 7 days, with the range of 7-730
cycleMode Integer Automatic backup loop mode
1: represents full backup every day
2: represents automatic backup in the full, increment, increment mode, such as full backup for the first day, increment backup for the second and third day; full backup again for the fourth day by analogy.
- supported by SQL Server
- not supported by MySQL
backupBinlog String Backup binlog or not
true: represents backup
false: represents not backup
- SQL Server does not support
- supported by MySQL

Return Code

Return Code Description
200 OK
Update Time:2019-07-11 18:54:31