Configuring a Same-Region Backup Policy

Function

This API is used to configure a same-region backup policy. Before calling this API:

Learn how to authorize and authenticate it.
Obtain the required region and endpoint.

URI

PUT /v3/{project_id}/instances/{instance_id}/backups/policy/update

**Table 1** URI parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID. Constraints N/A Range The value contains 32 characters. Only letters and digits are allowed. Default Value N/A
instance_id	Yes	String	Definition Instance ID, which uniquely identifies an instance. Constraints N/A Range The value contains 36 characters with a suffix of in07. Only letters and digits are allowed. Default Value N/A

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token. To obtain this value, call the IAM API for obtaining a user token. The value of X-Subject-Token in the response header is the token value. Constraints N/A Range N/A Default Value N/A
X-Language	No	String	Definition Request language type. Constraints N/A Range en-us zh-cn Default Value en-us

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
backup_policy	Yes	MysqlBackupPolicy object	Definition Database backup policy. Constraints N/A

**Table 4** MysqlBackupPolicy
Parameter	Mandatory	Type	Description
start_time	Yes	String	Definition Backup time window. Automated backups will be triggered during the backup time window. Constraints N/A Range The value cannot be empty. It must be a valid value in the "hh:mm-HH:MM" format. The current time is the UTC time. The HH value must be 1 greater than the hh value. The values of mm and MM must be the same and must be set to 00. Default Value N/A
keep_days	Yes	Integer	Definition Backup retention days. Constraints N/A Range 1–732. You can also contact customer service to extend the retention period to up to 3,660 days. Default Value N/A
period	Yes	String	Definition Backup cycle. Data will be automatically backed up on the selected days every week. Constraints The value is a list of numbers separated by commas (,), where each number plus one represents a day of the week for automated backups. For example, 1,2,3,4,5,6,7 indicates that data is backed up every day from Tuesday to Monday. Range You can select multiple numbers from 1 to 7 and separate them with commas (,). Default Value N/A
retention_num_backup_level1	No	Integer	Definition Number of retained level-1 backups. Constraints This parameter is only required when the level-1 backup function is enabled. Range 0 or 1 Default Value 0

Response Parameters

Status code: 200

**Table 5** Response body parameters
Parameter	Type	Description
status	String	Definition Status. Range N/A
instance_id	String	Definition Instance ID, which is compliant with the UUID format. Range The value is the same as the instance ID in the request.
instance_name	String	Definition Instance name. Range Instance name corresponding to the instance ID

Status code: 400

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 500

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Example Request

Modifying the automated backup policy of the DB instance (Data is backed up from 19:00 to 20:00 every Monday to Friday. Backup files are stored for seven days.)

PUT https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/ba62a0b83a1b42bfab275829d86ac0fdin07/backups/policy/update
{
  "backup_policy" : {
    "keep_days" : 7,
    "start_time" : "19:00-20:00",
    "period" : "1,2,3,4,5"
  }
}

Example Response

Status code: 200

Success.

{
  "status" : "COMPLETED",
  "instance_id" : "ba62a0b83a1b42bfab275829d86ac0fdin07",
  "instance_name" : "gauss-mysql"
}

Status Code

For details, see Status Codes.

Error Code

For details, see Error Codes.

Parent topic: Backup Management

Previous topic: Backup Management

Next topic: Creating a Manual Backup

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.

Chatbot