Obtaining an Automated Backup Policy

Function

This API is used to obtain an automated backup policy.

• Before calling this API, learn how to authenticate it.
• Before calling this API, learn about request header parameters.

URI

• URI format

  GET /v3/{project_id}/instances/{instance_id}/backups/policy

• Parameter description

  Table 1 Parameters

  Parameter	Mandatory	Description
  project_id	Yes	Project ID of a tenant in a region. To obtain the value, see Obtaining a Project ID.
  instance_id	Yes	Specifies the DB instance ID.

Request

• Request parameters

  None

• URI example

  GET https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01/backups/policy

Response

• Normal response

  Table 2 Parameters

  Parameter	Type	Description
  backup_policy	Object	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

  Parameter	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. The current time is the UTC time.
  period	String	Indicates the backup cycle configuration. Data will be automatically backed up on the selected days every week.

• Example normal response

  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.

Status Code

• Normal

  200

• Abnormal

  For details, see Status Codes.

Error Code

For details, see Error Codes.