Restore SAP HANA Databases with CreateHanaRestore API - Cloud Backup - Alibaba Cloud - Cloud Backup

Creates a restore job for an SAP HANA database.

Operation description

This operation restores a database to a specified state. Proceed with caution. For more information, see Restore databases to an SAP HANA instance.

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

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
VaultId	string	No	The ID of the backup vault.	v-000************yqr
ClusterId	string	Yes	The ID of the SAP HANA instance that you want to restore.	cl-000fbrs5******ka9w
DatabaseName	string	Yes	The name of the database that you want to restore.	TS2
BackupId	integer	No	The ID of the backup.	1645628400235
Mode	string	Yes	The recovery mode. Valid values: RECOVERY_TO_MOST_RECENT: restores the database to the most recent backed-up state. 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
RecoveryPointInTime	integer	No	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
LogPosition	integer	No	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
VolumeId	integer	No	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
UseCatalog	boolean	No	Whether to use a catalog backup to restore the database. This parameter is required only if you set the Mode parameter to RECOVERY_TO_SPECIFIC_BACKUP. If you do not use a catalog backup, you must specify a backup file prefix. Cloud Backup then finds and restores the matching backup file.	false
BackupPrefix	string	Yes	The backup prefix.	COMPLETE_DATA_BACKUP_2022_05_02_15_39
SystemCopy	boolean	No	Whether to restore the database to a different instance.	false
Source	string	No	The name of the source system. Set the value in the `<Source database name>@SID` format.	HNP@HNP
SourceClusterId	string	No	The ID of the source SAP HANA instance.	cl-000ii8tzv******xm0t
ClearLog	boolean	No	Whether to delete all log entries from the log area after the restore completes. Valid values: true and false. If you set the value to false, all log entries are deleted from the log area after the restore completes.	false
CheckAccess	boolean	No	Whether to validate the differential backup and log backup before the restore starts. Valid values: true and false. If you set the value to true, Cloud Backup checks whether the required differential backup and log backup are available. If either is unavailable, the restore job does not start.	false
UseDelta	boolean	No	Whether to use a differential backup or incremental backup to restore the database. Valid values: true and false. If you set the value to true, a differential or incremental backup is used. If you set the value to false, Cloud Backup uses a log backup instead.	true
SidAdmin	string	No	The SID admin account that is created by SAP HANA.	DB
MasterClientId	string	No	The ID of the client where the primary node of the SAP HANA resides.	c-000ii8tzv**********

Response elements

Element	Type	Description	Example
	object
Code	string	The HTTP status code. The value 200 indicates a successful call.	200
Message	string	The returned message. "successful" is returned for successful calls. Otherwise, an error message is returned.	successful
RequestId	string	The ID of the request.	EEC65C22-2152-5E31-8AD6-D6CBF1BFF49F
Success	boolean	Indicates whether the call is successful. Valid values: true: The call is successful. false: The call fails.	true
RestoreId	string	The ID of the restore job.	hr-000fb9bz190p1rse6jwv

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.