Querying an Automated Backup Policy

Function

This API is used to query an automated backup policy.

URI

• URI format

  GET /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.
  instance_id	Yes	Specifies the DB instance ID.

Requests

• Request header

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

• Request body

  N/A

Responses

• Parameter description

  Table 2 Parameter description

  Name	Type	Description
  backup_policy	Object	Indicates 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	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.
  period	String	Indicates 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.