Obtaining an Automated Backup Policy¶
Function¶
This API is used to obtain an automated backup policy information.
URI¶
URI format
PATH: /rds/v1/{project_id}/instances/{instanceId}/backups/policy
Method: GET
Parameter description
Table 1 Parameter description¶ Name
Mandatory
Description
project_id
Yes
Specifies the project ID of a tenant in a region.
instanceId
Yes
Specifies the primary node ID of the DB instance.
Note
This field is not the DB instance ID. You are advised to use API v3 and the DB instance ID to perform related operations.
Request¶
None
Normal Response¶
Parameter description
Table 2 Parameter description¶ Name
Type
Description
policy
Dictionary data structure. For details, see Table 3.
Indicates the backup policy objects, including the backup retention period (days) and backup start time.
Table 3 policy field data structure description¶ Name
Type
Description
keepday
Int
Indicates the number of days to retain the generated backup files.
The value range is from 0 to 732. If this parameter is 0, the automated backup policy is not set. To extend the retention period, contact customer service. Automated backups can be retained for up to 2562 days.
starttime
String
Indicates the backup start time that has been set. The backup task will be triggered within one hour after the backup start time.
Valid value:
The value cannot be empty. The format can be hh:mm:ss or hh:mm and must be valid. The time is in the UTC format.
Response example
{ "policy": { "keepday": 7, "starttime": "00:00:00" } }
Abnormal Response¶
For details, see Abnormal Request Results.