This API is used to obtain an automated backup policy.
GET https://{Endpoint}/v3/{project_id}/instances/{instance_id}/backups/policy
Name |
Mandatory |
Description |
---|---|---|
project_id |
Yes |
Specifies the 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. |
Name |
Type |
Description |
---|---|---|
backup_policy |
Object |
Indicates the backup policy objects, including the backup retention period (days) and backup start time. For details, see Table 3. |
Name |
Type |
Description |
---|---|---|
keep_days |
Integer |
Indicates the number of days to retain the backup files. |
start_time |
String |
Indicates the backup time window. Automated backups will be triggered during the backup time window. The value must be a valid value in the "hh:mm-HH:MM" format. The current time is in the UTC format.
|
period |
String |
Indicates the backup cycle configuration. Data will be automatically backed up on the selected days every week. |
When the automated backup policy is disabled:
{ "backup_policy": { "keep_days": 0 } }
When the automated backup policy is enabled:
{ "backup_policy": { "keep_days": 7, "start_time": "19:00-20:00", "period": "1,2" } }
For details, see Abnormal Request Results.
For details, see Status Codes.
For details, see Error Codes.