DescribeHanaBackupSetting - Cloud Backup - Alibaba Cloud Documentation Center

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

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

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 parameters

Parameter	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.	9D0DB5BC-5071-5ADF-BCD1-14EBB0C17C54
Success	boolean	Indicates whether the call is successful. Valid values: true: The call is successful. false: The call 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	long	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

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 time	Summary of changes	Operation

No change history