Help Center/ Document Database Service/ API Reference/ APIs V3.0 (Recommended)/ Backup and Restoration/ Querying an Automated Backup Policy
Updated on 2022-12-12 GMT+08:00
View PDF

Querying an Automated Backup Policy

Description

This API is used to query an automated backup policy.

URI

  • URI format

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

  • URI example

    https://dds.ap-southeast-1.myhuaweicloud.com/v3/97b026aa9cc4417888c14c84a1ad9860/instances/cc6345c64cec47499182467ea0dd432ain02/backups/policy

Table 1 Request parameters

Name

Type

IN

Mandatory

Description

x-auth-token

string

header

Yes

User token

project_id

string

path

Yes

Project ID of a tenant in a region. To obtain the project ID, see Obtaining a Project ID.

instance_id

string

path

Yes

Instance ID, which can be obtained by calling the API described in Querying Instances and Details. If you do not have an instance, call the API described in Creating a DB Instance to create one.

Requests

None

Responses

  • Parameter description
    Table 2 Parameter description

    Name

    Type

    Mandatory

    Description

    backup_policy

    Object

    Yes

    The backup policy object, including the backup retention period (days) and start time. For more information, see Table 3.
    Table 3 backup_policy field data structure description

    Name

    Type

    Mandatory

    Description

    keep_days

    Integer

    Yes

    The number of days to retain the backup files.

    start_time

    String

    No

    The backup time window. Automated backups will be triggered during the backup time window.

    period

    String

    No

    The backup cycle configuration. Data will be automatically backed up on the selected days every week.
  • Response example
    Enable the automated backup policy. 
    { 
    "backup_policy": { 
        "keep_days": 7, 
        "start_time": "19:00-20:00",
        "period": "1,2,4,5,6" 
    } 
}
    Disabled the automated backup policy. 
    {
    "backup_policy": {
        "keep_days": 0
    }
}

Status Code

For more information, see Status Code.

Error Code

For more information, see Error Code.

Parent topic: Backup and Restoration