All Products
Search

This Product

    Cloud Backup:DescribeHanaBackupSetting

    Document Center

    Cloud Backup:DescribeHanaBackupSetting

    Last Updated:Aug 27, 2026

    Queries the backup parameters of an SAP HANA database.

    Operation description

    To query the backup retention period of a database, call the DescribeHanaRetentionSetting operation.

    Try it now

    Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

    Test

    RAM authorization

    No authorization for this operation. If you encounter issues with this operation, contact technical support.

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    VaultId

    string

    No

    The ID of the backup vault.

    v-000css******za5uyqr
    ClusterId

    string

    Yes

    The ID of the SAP HANA instance.

    cl-00068btz******oku
    DatabaseName

    string

    No

    The name of the database.

    SYSTEMDB

    Response elements

    Element

    Type

    Description

    Example

    object

    Code

    string

    The HTTP status code. A value of 200 indicates that the request is successful.

    200
    Message

    string

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

    successful
    RequestId

    string

    The ID of the request.

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

    boolean

    Indicates whether the request is successful. Valid values:

    • true: The request is successful.

    • false: The request fails.

    true
    HanaBackupSetting

    object

    The backup settings.

    DatabaseName

    string

    The name of the database.

    SYSTEMDB
    LogBackupUsingBackint

    boolean

    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
    CatalogBackupParameterFile

    string

    The configuration file for catalog backup.

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

    boolean

    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
    DataBackupParameterFile

    string

    The configuration file for data backup.

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

    integer

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

    900
    EnableAutoLogBackup

    boolean

    Indicates whether automatic log backup is enabled. Valid values:

    • true: Automatic log backup is enabled.

    • false: Automatic log backup is disabled.

    true
    LogBackupParameterFile

    string

    The configuration file for log backup.

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

    Examples

    Success response

    JSON format

    {
  "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": false,
    "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

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.