Function

This API is used to query an automated backup policy.

• Learn how to authenticate this API before using it.
• Before calling this API, obtain the required region and endpoint.

URI

• URI format

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

• Example

  GET https://{Endpoint}/mysql/v3/97b026aa9cc4417888c14c84a1ad9860/instances/43e4feaab48f11e89039fa163ebaa7e4br01/backups/policy

• Parameter description

  Table 1 Parameter description

  Name	Type	Mandatory	Description
  project_id	String	Yes	Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID.
  instance_id	String	Yes	DB instance ID.

Request

None

Response

• Normal response

  Table 2 Parameter description

  Name	Type	Description
  backup_policy	object	Backup policy information For details, see Table 3.

  Table 3 backup_policy field data structure description

  Name	Type	Description
  keep_days	Integer	Backup retention days.
  start_time	String	Backup time window. Automated backups will be triggered during the backup time window.
  period	String	Backup cycle configuration. Data will be automatically backed up on the selected days every week.
  retention_num_backup_level1	Integer	Number of retained level-1 backups. This parameter is returned when the level-1 backup function is enabled.
• Example normal response

  {
  "backup_policy": {
  "keep_days": 7,
  "start_time": "19:00-20:00",
  "period": "1,2",
  " retention_num_backup_level1": 1
  }
  }

Status Code

For details, see Status Codes.

Error Code

For details, see Error Codes.