Obtaining an Automated Backup Policy¶

Function¶

This API is used to obtain an automated backup policy.

URI format
GET https://{Endpoint}/v3/{project_id}/instances/{instance_id}/backups/policy

Parameter description

**Table 1** Parameter description¶
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.

Normal response

**Table 2** Parameter description¶
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.

**Table 3** backup_policy field data structure description¶
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. The HH value must be 1 greater than the hh value. The values of mm and MM must be the same and must be set to any of the following: 00, 15, 30, or 45.
period	String	Indicates the backup cycle configuration. Data will be automatically backed up on the selected days every week.

Example normal response

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 Error Codes.

last updated: 2024-12-10 15:16 UTC - commit: 148bbcaa587d5f60ca229a738ab0fb7c0ed09ff7