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

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

Table 1 Path parameters

Name

Type

IN

Mandatory

Description

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.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token

Response Parameters

Table 3 Parameter description

Parameter

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 4.
Table 4 backup_policy field data structure description

Parameter

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.
  • Example response
    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 details, see Status Code.

Error Code

For details, see Error Code.

Parent topic: Backup and Restoration