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 the request header parameters.

Authorization Information

URI

• URI format

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

• Parameter description

  Table 1 Parameters

  Parameter	Mandatory	Description
  project_id	Yes	Definition Project ID of a tenant in a region. Constraints The value cannot be empty. Range To obtain the value, see Obtaining a Project ID. Default Value N/A
  instance_id	Yes	Definition Instance ID. Constraints The value cannot be empty. Range You can obtain the value of this parameter from id in Table 4 by calling the API for querying DB instances. Default Value N/A

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	Definition 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	Definition Indicates the number of days to retain the backup files. Range N/A
  start_time	String	Definition Indicates the backup time window. Automated backups will be triggered during the backup time window. The current time is the UTC time. Range N/A
  period	String	Definition Indicates the backup cycle configuration. Data will be automatically backed up on the selected days every week. Range N/A

• Example normal response

  {
  	"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.