All Products
Search
Document Center

Hybrid Backup Recovery:CreateHanaRestore

Last Updated:Nov 14, 2022

Creates a restore job for an SAP HANA database.

Operation Description

If you call this operation to restore a database, the database is restored to a specified state. Proceed with caution. For more information, see Restore databases to an SAP HANA instance.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
ClusterIdstringYes

The ID of the SAP HANA instance that you want to restore.

cl-000fbrs5******ka9w
DatabaseNamestringYes

The name of the database that you want to restore.

TS2
BackupIdlongYes

The ID of the backup.

1645628400235
ModestringYes

The recovery mode. Valid values:

  • RECOVERY_TO_MOST_RECENT: restores the database to the recently available state to which the database has been backed up.
  • RECOVERY_TO_POINT_IN_TIME: restores the database to a specified point in time.
  • RECOVERY_TO_SPECIFIC_BACKUP: restores the database to a specified backup.
  • RECOVERY_TO_LOG_POSITION: restores the database to a specified log position.
RECOVERY_TO_POINT_IN_TIME
RecoveryPointInTimelongNo

The point in time to which you want to restore the database. This parameter is valid only if you set the Mode parameter to RECOVERY_TO_POINT_IN_TIME. HBR restores the database to a state closest to the specified point in time.

1635315505
LogPositionlongNo

The log position to which you want to restore the database. This parameter is valid only if you set the Mode parameter to RECOVERY_TO_LOG_POSITION.

0
VolumeIdintegerNo

The ID of the volume that you want to restore. This parameter is valid only if you set the Mode parameter to RECOVERY_TO_LOG_POSITION.

0
UseCatalogbooleanNo

Specifies whether to use a catalog backup to restore the database. This parameter is valid only if you set the Mode parameter to RECOVERY_TO_SPECIFIC_BACKUP. If you do not use a catalog backup, you must specify the prefix of a backup file. Then, HBR finds the backup file based on the specified prefix and restores the backup file.

false
BackupPrefixstringYes

The backup prefix.

COMPLETE_DATA_BACKUP_2022_05_02_15_39
SystemCopybooleanNo

Specifies whether to restore the database to a different instance.

false
SourcestringNo

The name of the source system. This parameter specifies the name of the source database that you want to restore. You must set the parameter in the <Source database name>@SID format.

HNP@HNP
SourceClusterIdstringNo

The ID of the source SAP HANA instance.

cl-000ii8tzv******xm0t
ClearLogbooleanNo

Specifies whether to delete all log entries from the log area after the log entries are restored. Valid values: true and false. If you set the value to false, all log entries are deleted from the log area after the log entries are restored.

false
CheckAccessbooleanNo

Specifies whether to validate the differential backup and log backup. Valid values: true and false. If you set the value to true, HBR checks whether the required differential backup and log backup are available before the restore job starts. If the differential backup or log backup is unavailable, HBR does not start the restore job.

false
UseDeltabooleanNo

Specifies whether to use a differential backup or an incremental backup to restore the database. Valid values: true and false. If you want to use a differential backup or an incremental backup to restore the database, set the value to true. If you set the value to false, HBR uses a log backup to restore the database.

true
SidAdminstringNo

The SID admin account that is created by SAP HANA.

DB

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.

EEC65C22-2152-5E31-8AD6-D6CBF1BFF49F
Successboolean

Indicates whether the call is successful. Valid values:

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

The ID of the restore job.

hr-000fb9bz190p1rse6jwv

Example

Request example

http(s)://[Endpoint]/?Action=CreateHanaRestore
&ClusterId=cl-000fbrs5******ka9w
&DatabaseName=TS2
&BackupId=1645628400235
&Mode=RECOVERY_TO_POINT_IN_TIME
&RecoveryPointInTime=1635315505
&LogPosition=0
&VolumeId=0
&UseCatalog=false
&BackupPrefix=COMPLETE_DATA_BACKUP_2022_05_02_15_39
&SystemCopy=false
&Source=HNP@HNP
&SourceClusterId=cl-000ii8tzv******xm0t
&ClearLog=false
&CheckAccess=false
&UseDelta=true
&SidAdmin=DB
&Common request parameters

Normal return example

JSONFormat

{
  "Code": "200",
  "Message": "successful",
  "RequestId": "EEC65C22-2152-5E31-8AD6-D6CBF1BFF49F",
  "Success": true,
  "RestoreId": "hr-000fb9bz190p1rse6jwv"
}

Error codes

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