UpdateHanaRetentionSetting - Cloud Backup - Alibaba Cloud Documentation Center

Updates the backup retention period of an SAP HANA database.

Operation description

If you want to update the backup parameters of a database, you can call the UpdateHanaBackupSetting operation.
HBR deletes the expired catalogs and data that are related to Backint and file backup. The deleted catalogs and data cannot be restored. We recommend that you set the retention period based on your business requirements.

There is currently no authorization information disclosed in the API.

Parameter	Type	Required	Description	Example
VaultId	string	No	The ID of the backup vault.	v-000fb0v2ly******k6
ClusterId	string	No	The ID of the SAP HANA instance.	cl-00024vyjj******srrq
Schedule	string	Yes	The policy to update the retention period. Format: `I\|{startTime}\|{interval}`. The retention period is updated at an interval of {interval} starting from {startTime}. startTime: the time at which the system starts to update the retention period. The time must follow the UNIX time format. Unit: seconds. interval: the interval at which the system updates the retention period. The interval must follow the ISO 8601 standard. For example, PT1H specifies an interval of 1 hour and P1D specifies an interval of one day.	I\|0\|P1D
RetentionDays	long	Yes	The number of days for which the backup is retained. If you set the Disabled parameter to false, the backup is retained for the number of days specified by this parameter.	90
Disabled	boolean	Yes	Specifies whether to permanently retain the backup. Valid values: true: The backup is permanently retained. false: The backup is retained for the specified number of days.	false
DatabaseName	string	Yes	The name of the database.	SYSTEMDB

Parameter	Type	Description	Example
	object
Code	string	The HTTP status code. The status code 200 indicates that the call is successful.	200
Message	string	The message that is returned. If the call is successful, "successful" is returned. If the call fails, an error message is returned.	successful
RequestId	string	The ID of the request.	7BEE26EB-8EE3-57A0-A9DE-5FD700165DE5
Success	boolean	Indicates whether the call is successful. Valid values: true: The call is successful. false: The call fails.	true

Sample success responses

JSONformat

{
  "Code": "200",
  "Message": "successful",
  "RequestId": "7BEE26EB-8EE3-57A0-A9DE-5FD700165DE5",
  "Success": true
}

For a list of error codes, visit the Service error codes.

Change time	Summary of changes	Operation

No change history