All Products
Search
Document Center

Hybrid Backup Recovery:DescribeHanaBackupSetting

Last Updated:Nov 14, 2022

Queries the backup parameters of an SAP HANA database.

Operation Description

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

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
VaultIdstringNo

The ID of the backup vault.

v-000css******za5uyqr
ClusterIdstringYes

The ID of the SAP HANA instance.

cl-00068btz******oku
DatabaseNamestringNo

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.

9D0DB5BC-5071-5ADF-BCD1-14EBB0C17C54
Successboolean

Indicates whether the call is successful. Valid values:

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

The backup settings.

DatabaseNamestring

The name of the database.

SYSTEMDB
LogBackupUsingBackintboolean

Indicates whether Backint is used to back up logs. Valid values:

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

The configuration file for catalog backup.

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

Indicates whether Backint is used to back up catalogs. Valid values:

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

The configuration file for data backup.

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

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

900
EnableAutoLogBackupboolean

Indicates whether automatic log backup is enabled. Valid values:

  • true: Automatic log backup is enabled.
  • false: Automatic log backup is disabled.
true
LogBackupParameterFilestring

The configuration file for log backup.

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

Example

Request example

http(s)://[Endpoint]/?Action=DescribeHanaBackupSetting
&VaultId=v-000css******za5uyqr
&ClusterId=cl-00068btz******oku
&DatabaseName=SYSTEMDB
&Common request parameters

Normal return example

JSONFormat

{
  "Code": "200",
  "Message": "successful",
  "RequestId": "9D0DB5BC-5071-5ADF-BCD1-14EBB0C17C54",
  "Success": true,
  "HanaBackupSetting": {
    "DatabaseName": "SYSTEMDB",
    "LogBackupUsingBackint": true,
    "CatalogBackupParameterFile": "/usr/sap/SID/SYS/global/hdb/opt/hdbconfig/param",
    "CatalogBackupUsingBackint": true,
    "DataBackupParameterFile": "/usr/sap/SID/SYS/global/hdb/opt/hdbconfig/param",
    "LogBackupTimeout": 900,
    "EnableAutoLogBackup": true,
    "LogBackupParameterFile": "/usr/sap/SID/SYS/global/hdb/opt/hdbconfig/param"
  }
}

Error codes

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