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.

  • Before calling this API, obtain the required region and endpoint.

URI

  • URI format

    PUT 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.

Request

  • Parameter description

    Table 2 Parameter description

    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.

    Table 3 backup_policy field data structure description

    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.

    Important

    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.

    • 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.

    Example value:

    • 08:15-09:15

    • 23:00-00:00

    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.

  • Request example

    PUT https://{Endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01/backups/policy
    

    Modifying the automated backup policy:

    {
        "backup_policy": {
            "keep_days": 7,
            "start_time": "19:00-20:00",
            "period": "1,2"
        }
    }
    

    Disabling the automated backup policy:

    {
        "backup_policy": {
            "keep_days": 0
        }
    }
    

Response

Status Code

Error Code

For details, see Error Codes.