DescribeHanaRestores API Overview for SAP HANA Restore Jobs - Cloud Backup - Alibaba Cloud - Cloud Backup

Queries one or more SAP HANA restore jobs that meet the specified conditions.

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

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
VaultId	string	No	The ID of the backup vault.	v-000au6bq******mpu
ClusterId	string	Yes	The ID of the SAP HANA instance.	cl-000b******soejg
PageNumber	integer	No	The page number. Pages start from page 1. Default value: 1.	1
PageSize	integer	No	The number of entries per page. Valid values: 1 to 99. Default value: 10.	10
RestoreId	string	No	The ID of the restore job.	r-0007o3vqfukfe92hvf13
DatabaseName	string	No	The database name.	SYSTEMDB
BackupId	integer	No	The backup ID.	1632754800158
RestoreStatus	string	No	The status of the restore job. Valid values: RUNNING: The job is running. COMPLETE: The job is completed. PARTIAL_COMPLETE: The job is partially completed. FAILED: The job failed. CANCELED: The job is canceled. EXPIRED: The job timed out.	COMPLETE
ResourceGroupId	string	No	The ID of the resource group.	rg-acfm4ebtpkzx7zy

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	7DEFC897-8F05-5C05-912C-C9A9510FBFF1
Success	boolean	Indicates whether the request was successful. Valid values: true false	true
Code	string	The response code. Status code 200 indicates success.	200
Message	string	The returned message. If the request was successful, "successful" is returned. Otherwise, an error message is returned.	successful
PageNumber	integer	The page number. Pages start from page 1. Default value: 1.	1
PageSize	integer	The number of entries per page. Valid values: 1 to 99. Default value: 10.	10
TotalCount	integer	The total number of entries returned.	19
HanaRestore	object
HanaRestores	array<object>	The information about restore jobs.
	object	The restore job.
Status	string	The status of the restore job. Valid values: RUNNING: The job is running. COMPLETE: The job is completed. PARTIAL_COMPLETE: The job is partially completed. FAILED: The job failed. CANCELED: The job is canceled. EXPIRED: The job timed out.	COMPLETE
ReachedTime	integer	The point in time at which the database is restored.	1635315505
VaultId	string	The ID of the backup vault.	v-000g9acf******gta
CurrentPhase	integer	The current recovery phase. This value is obtained from SAP HANA.	2
ClearLog	boolean	Indicates whether all log entries are deleted from the log area after the log entries are restored. Valid values: true and false. If the return value is false, all log entries are deleted from the log area after the log entries are restored.	true
Message	string	The details of the recovery phase.	SQL Error 448 - recovery could not be completed:
CheckAccess	boolean	Indicates whether the differential backup and log backup are validated. Valid values: true: Cloud Backup 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, Cloud Backup does not start the restore job. false: Cloud Backup does not check whether the required differential backup and log backup are available before the restore job starts.	true
Mode	string	The recovery mode. Valid values: RECOVERY_TO_MOST_RECENT: The database is restored to the most recent available backup state. RECOVERY_TO_POINT_IN_TIME: The database is restored to a specified point in time. RECOVERY_TO_SPECIFIC_BACKUP: The database is restored to a specified backup. RECOVERY_TO_LOG_POSITION: The database is restored to a specified log position.	RECOVERY_TO_SPECIFIC_BACKUP
SystemCopy	boolean	Indicates whether the database is restored to a different instance. Valid values: true: The database is restored to a different instance. false: The database is restored within the same instance.	true
CurrentProgress	integer	The current progress. This value is obtained from SAP HANA.	1
UseDelta	boolean	Indicates whether a differential or incremental backup is used to restore the database. Valid values: true: A differential or incremental backup is used. false: A log backup is used.	true
BackupID	integer	The backup ID.	1635315505
SourceClusterId	string	The ID of the source SAP HANA instance.	cl-0000g3mvy******5cj
VolumeId	integer	The ID of the volume that is restored. This parameter is returned only if the value of the Mode parameter is RECOVERY_TO_LOG_POSITION.	0
DatabaseName	string	The database name.	BWD
Phase	string	The recovery phase.	restart
ClusterId	string	The ID of the SAP HANA instance that is restored.	cl-000923yu******p00j4
DatabaseRestoreId	integer	The ID of the database recovery.	1644038961030
State	string	The recovery status. This value is obtained from SAP HANA.	successful
Source	string	The name of the source system. This parameter indicates the name of the source database that is restored. Format: `<Source database name>@SID`.	PRD@H4P
MaxPhase	integer	The maximum recovery phase. This value is obtained from SAP HANA.	4
EndTime	integer	The time when the restore job ends. This value is a UNIX timestamp. Unit: seconds.	1634356382
StartTime	integer	The time when the restore job starts. This value is a UNIX timestamp. Unit: seconds.	1636970413
BackupPrefix	string	The backup prefix.	INC_DATA_BACKUP
RestoreId	string	The ID of the restore job.	r-000c1en183ayn9sesgqh
LogPosition	integer	The log position to which the database is restored. This parameter is returned only if the value of the Mode parameter is RECOVERY_TO_LOG_POSITION.	0
RecoveryPointInTime	integer	The point in time to which the database is restored. This parameter is returned only if the value of the Mode parameter is RECOVERY_TO_POINT_IN_TIME. Cloud Backup restores the database to a state closest to the specified point in time.	1649851200
MaxProgress	integer	The maximum progress. This value is obtained from SAP HANA.	1
UseCatalog	boolean	Indicates whether a catalog backup is used to restore the database. This parameter is returned only if the value of the Mode parameter is RECOVERY_TO_SPECIFIC_BACKUP. If the value is false, Cloud Backup finds the backup file based on the specified prefix and restores it.	false

Examples

Success response

JSON format

{
  "RequestId": "7DEFC897-8F05-5C05-912C-C9A9510FBFF1",
  "Success": true,
  "Code": "200",
  "Message": "successful",
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 19,
  "HanaRestore": {
    "HanaRestores": [
      {
        "Status": "COMPLETE",
        "ReachedTime": 1635315505,
        "VaultId": "v-000g9acf******gta",
        "CurrentPhase": 2,
        "ClearLog": true,
        "Message": "SQL Error 448 - recovery could not be completed:",
        "CheckAccess": true,
        "Mode": "RECOVERY_TO_SPECIFIC_BACKUP",
        "SystemCopy": true,
        "CurrentProgress": 1,
        "UseDelta": true,
        "BackupID": 1635315505,
        "SourceClusterId": "cl-0000g3mvy******5cj",
        "VolumeId": 0,
        "DatabaseName": "BWD",
        "Phase": "restart",
        "ClusterId": "cl-000923yu******p00j4",
        "DatabaseRestoreId": 1644038961030,
        "State": "successful",
        "Source": "PRD@H4P",
        "MaxPhase": 4,
        "EndTime": 1634356382,
        "StartTime": 1636970413,
        "BackupPrefix": "INC_DATA_BACKUP",
        "RestoreId": "r-000c1en183ayn9sesgqh",
        "LogPosition": 0,
        "RecoveryPointInTime": 1649851200,
        "MaxProgress": 1,
        "UseCatalog": false
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.