All Products
Search
Document Center

Hybrid Backup Recovery:UpdateHanaRetentionSetting

Last Updated:Nov 14, 2022

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.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
VaultIdstringNo

The ID of the backup vault.

v-000fb0v2ly******k6
ClusterIdstringNo

The ID of the SAP HANA instance.

cl-00024vyjj******srrq
SchedulestringYes

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
RetentionDayslongYes

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
DisabledbooleanYes

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
DatabaseNamestringYes

The name of the database.

SYSTEMDB

Response parameters

ParameterTypeDescriptionExample
object
Codestring

The HTTP status code. The status code 200 indicates that the call is successful.

200
Messagestring

The message that is returned. If the call is successful, "successful" is returned. If the call fails, an error message is returned.

successful
RequestIdstring

The ID of the request.

7BEE26EB-8EE3-57A0-A9DE-5FD700165DE5
Successboolean

Indicates whether the call is successful. Valid values:

  • true: The call is successful.
  • false: The call fails.
true

Example

Request example

http(s)://[Endpoint]/?Action=UpdateHanaRetentionSetting
&VaultId=v-000fb0v2ly******k6
&ClusterId=cl-00024vyjj******srrq
&Schedule=I|0|P1D
&RetentionDays=90
&Disabled=false
&DatabaseName=SYSTEMDB
&Common request parameters

Normal return example

JSONFormat

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

Error codes

For a list of error codes, visit the API error center.