All Products
Search
Document Center

Hybrid Backup Recovery:UpdateHanaBackupSetting

Last Updated:Nov 14, 2022

Updates the backup parameters of an SAP HANA database.

Operation Description

If you want to update the backup retention period of a database, you can call the UpdateHanaRetentionSetting operation.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
VaultIdstringNo

The ID of the backup vault.

v-0005n******rluw5
ClusterIdstringYes

The ID of the SAP HANA instance.

cl-000ezvg******8znz
DatabaseNamestringYes

The name of the database.

SYSTEMDB
EnableAutoLogBackupbooleanYes

Specifies whether to enable automatic log backup. Valid values:

  • true: enables automatic log backup.
  • false: disables automatic log backup.
true
DataBackupParameterFilestringNo

The configuration file for data backup.

/usr/sap/SID/SYS/global/hdb/opt/hdbconfig/param
LogBackupParameterFilestringNo

The configuration file for log backup.

/usr/sap/SID/SYS/global/hdb/opt/hdbconfig/param
LogBackupUsingBackintbooleanYes

Specifies whether to use Backint to back up logs. Valid values:

  • true: Backint is used to back up logs.
  • false: Backint is not used to back up logs.
true
LogBackupTimeoutlongNo

The interval at which logs are backed up. Unit: seconds.

900
CatalogBackupUsingBackintbooleanYes

Specifies whether to use Backint to back up catalogs. Valid values:

  • true: Backint is used to back up catalogs.
  • false: Backint is not used to back up catalogs.
true
CatalogBackupParameterFilestringNo

The configuration file for catalog backup.

/usr/sap/SID/SYS/global/hdb/opt/hdbconfig/param

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.

4892D474-9A4A-5298-BCD3-E46112A1EFD0
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=UpdateHanaBackupSetting
&VaultId=v-0005n******rluw5
&ClusterId=cl-000ezvg******8znz
&DatabaseName=SYSTEMDB
&EnableAutoLogBackup=true
&DataBackupParameterFile=/usr/sap/SID/SYS/global/hdb/opt/hdbconfig/param
&LogBackupParameterFile=/usr/sap/SID/SYS/global/hdb/opt/hdbconfig/param
&LogBackupUsingBackint=true
&LogBackupTimeout=900
&CatalogBackupUsingBackint=true
&CatalogBackupParameterFile=/usr/sap/SID/SYS/global/hdb/opt/hdbconfig/param
&Common request parameters

Normal return example

JSONFormat

{
  "Code": "200",
  "Message": "successful",
  "RequestId": "4892D474-9A4A-5298-BCD3-E46112A1EFD0",
  "Success": true
}

Error codes

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