All Products
Search

This Product

    Cloud Backup:UpdateHanaBackupSetting

    Document Center

    Cloud Backup:UpdateHanaBackupSetting

    Last Updated:Aug 28, 2026

    Updates the backup parameters of an SAP HANA database.

    Operation description

    You can call the UpdateHanaRetentionSetting operation to update the backup retention period of a database.

    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

    The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

    • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

    • API: The API that you can call to perform the action.

    • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

    • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

      • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

      • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

    • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

    • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

    Action

    Access level

    Resource type

    Condition key

    Dependent action

    hbr:UpdateHanaBackupSetting

    update

    *All Resource

    *

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    VaultId

    string

    No

    The ID of the backup vault.

    v-0005n******rluw5
    ClusterId

    string

    Yes

    The ID of the SAP HANA instance.

    cl-000ezvg******8znz
    DatabaseName

    string

    Yes

    The name of the database.

    SYSTEMDB
    EnableAutoLogBackup

    boolean

    Yes

    Specifies whether to enable automatic log backup. Valid values:

    • true: enables automatic log backup.

    • false: disables automatic log backup.

    true
    DataBackupParameterFile

    string

    No

    The configuration file for data backup.

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

    string

    No

    The configuration file for log backup.

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

    boolean

    Yes

    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
    LogBackupTimeout

    integer

    No

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

    900
    CatalogBackupUsingBackint

    boolean

    Yes

    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
    CatalogBackupParameterFile

    string

    No

    The configuration file for catalog backup.

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

    Response elements

    Element

    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.

    4892D474-9A4A-5298-BCD3-E46112A1EFD0
    Success

    boolean

    Indicates whether the call is successful. Valid values:

    • true: The call is successful.

    • false: The call fails.

    true

    Examples

    Success response

    JSON format

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

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.