All Products
Search

This Product

    Cloud Backup:DescribeHanaBackupSetting

    Document Center

    Cloud Backup:DescribeHanaBackupSetting

    Last Updated:Dec 24, 2024

    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.

    Debugging

    You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

    Authorization information

    The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

    • Operation: the value that you can use in the Action element to specify the operation on a resource.
    • Access level: the access level of each operation. The levels are read, write, and list.
    • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
      • The required resource types are displayed in bold characters.
      • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
    • Condition Key: the condition key that is defined by the cloud service.
    • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
    OperationAccess levelResource typeCondition keyAssociated operation
    hbr:DescribeHanaBackupSettingget
    *All Resources
    *
      none
    		none

    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

    Examples

    Sample success responses

    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": 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

    For a list of error codes, visit the Service error codes.

    Change history

    Change timeSummary of changesOperation
    No change history