• Relational Database Service

rds
  1. Help Center
  2. Relational Database Service
  3. API Reference
  4. API v3 (Recommended)
  5. Backup and Restoration
  6. Obtaining an Automated Backup Policy

Obtaining an Automated Backup Policy

Function

This API is used to obtain an automated backup policy.

URI

  • URI format

    PATH: /{version_id}/{project_id}/instances/{instance_id}/backups/policy

    Method: GET

  • Parameter description
    Table 1 Parameter description

    Name

    Mandatory

    Description

    version_id

    Yes

    Specifies the API version. It is case-sensitive and the value is v3.

    project_id

    Yes

    Specifies the project ID of a tenant in a region.

    instance_id

    Yes

    Specifies the DB instance ID.

Request

None

Normal Response

  • Parameter description
    Table 2 Parameter description

    Name

    Type

    Description

    backup_policy

    Dictionary data structure

    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

    Int

    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.

    period

    String

    Indicates the backup cycle configuration. Data will be automatically backed up on the selected days every week.

  • Response example

    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"
    	}
    }

Abnormal Response

For details, see Abnormal Request Results.