Setting an Automated Backup Policy
Function
This API is used to set an automated backup policy.
- Before calling an API, you need to understand the API in Authentication.
URI
- URI format
- Parameter description
Table 1 Parameter description Name
Mandatory
Description
project_id
Yes
Project ID of a tenant in a region.
For details about how to obtain the project ID, see Obtaining a Project ID.
instance_id
Yes
Specifies the DB instance ID.
Request
Name |
Mandatory |
Type |
Description |
---|---|---|---|
backup_policy |
Yes |
Object |
Specifies the backup policy objects, including the backup retention period (days) and backup start time. For details, see Table 3. |
reserve_backups |
No |
Boolean |
Specifies whether to retain automated and unsynchronized backups. This parameter is valid only when the automated backup policy is disabled. The default value is true.
|
Name |
Mandatory |
Type |
Description |
---|---|---|---|
keep_days |
Yes |
Integer |
Specifies the number of days to retain the generated backup files. The value range is from 0 to 732. The value 0 indicates that the automated backup policy is disabled. To extend the retention period, contact customer service. Automated backups can be retained for up to 2,562 days.
NOTICE:
Once the automated backup policy is disabled, automated backups are no longer created and all incremental backups are deleted immediately. Operations related to the incremental backups, including downloads, replications, restorations, and rebuilds, may fail. |
start_time |
No |
String |
Specifies the backup time window. Automated backups will be triggered during the backup time window. This parameter is mandatory except that the automated backup policy is disabled. The value must be a valid value in the "hh:mm-HH:MM" format. The current time is in the UTC format.
Example value:
|
period |
No |
String |
Specifies the backup cycle configuration. Data will be automatically backed up on the selected days every week. This parameter is mandatory except that the automated backup policy is disabled. Value range: The value is a number separated by commas (,), indicating the days of the week. For example, the value 1,2,3,4 indicates that the backup period is Monday, Tuesday, Wednesday, and Thursday. |
Example Request
- Configure an automated backup policy for a DB instance, with backup cycle set to Monday and Tuesday, backup window to 19:00–20:00, and retention period to 7 days.
PUT https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01/backups/policy { "backup_policy": { "keep_days": 7, "start_time": "19:00-20:00", "period": "1,2" } }
- Disable an automated backup policy.
{ "backup_policy": { "keep_days": 0 }, "reserve_backups": false }
Response
- Normal response
- Abnormal response
For details, see Abnormal Request Results.
Status Code
- Normal
- Abnormal
For details, see Status Codes.
Error Code
For details, see Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot