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

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeHanaRestores

The operation that you want to perform. Set the value to DescribeHanaRestores.

VaultId String No v-000au6bq******mpu

The ID of the backup vault.

ClusterId String Yes cl-000b******soejg

The ID of the SAP HANA instance.

PageNumber Integer No 1

The number of the page to return. Pages start from page 1. Default value: 1.

PageSize Integer No 10

The number of entries to return on each page. Valid values: 1 to 99. Default value: 10.

RestoreId String No r-0007o3vqfukfe92hvf13

The ID of the restore job.

DatabaseName String No SYSTEMDB

The name of the database.

BackupId Long No 1632754800158

The ID of the backup.

RestoreStatus String No COMPLETE

The status of the restore job. Valid values:

  • RUNNING: The restore job is running.
  • COMPLETE: The restore job is completed.
  • PARTIAL_COMPLETE: The restore job is partially completed.
  • FAILED: The restore job has failed.
  • CANCELED: The restore job is canceled.
  • EXPIRED: The restore job has timed out.
ResourceGroupId String No rg-acfm4ebtpkzx7zy

The ID of the resource group.

Response parameters

Parameter Type Example Description
RequestId String 7DEFC897-8F05-5C05-912C-C9A9510FBFF1

The ID of the request.

Success Boolean true

Indicates whether the call is successful. Valid values:

  • true: The call is successful.
  • false: The call fails.
Code String 200

The HTTP status code. The status code 200 indicates that the call is successful.

Message String successful

The message that is returned. If the call is successful, "successful" is returned. If the call fails, an error message is returned.

PageNumber Integer 1

The page number of the returned page. Pages start from page 1. Default value: 1.

PageSize Integer 10

The number of entries returned on each page. Valid values: 1 to 99. Default value: 10.

TotalCount Integer 19

The total number of returned entries.

HanaRestore Array of HanaRestores

The information about restore jobs.

HanaRestores
Status String COMPLETE

The status of the restore job. Valid values:

  • RUNNING: The restore job is running.
  • COMPLETE: The restore job is completed.
  • PARTIAL_COMPLETE: The restore job is partially completed.
  • FAILED: The restore job has failed.
  • CANCELED: The restore job is canceled.
  • EXPIRED: The restore job has timed out.
ReachedTime Long 1635315505

The point in time at which the database is restored.

VaultId String v-000g9acf******gta

The ID of the backup vault.

CurrentPhase Integer 2

The current recovery phase. This value is obtained from SAP HANA.

ClearLog Boolean true

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.

Message String SQL Error 448 - recovery could not be completed:

The details of the recovery phase.

CheckAccess Boolean true

Indicates whether the differential backup and log backup are validated. Valid values:

  • 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: HBR does not check whether the required differential backup and log backup are available before the restore job starts.
Mode String RECOVERY_TO_SPECIFIC_BACKUP

The recovery mode. Valid values:

  • RECOVERY_TO_MOST_RECENT: The database is restored to the recently available state to which the database has been backed up.
  • 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.
SystemCopy Boolean true

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.
CurrentProgress Long 1

The current progress. This value is obtained from SAP HANA.

UseDelta Boolean true

Indicates whether a differential backup or an incremental backup is used to restore the database. Valid values: true and false. If the return value is true, HBR uses a differential backup or an incremental backup to restore the database. If the return value is false, HBR uses a log backup to restore the database.

BackupID Long 1635315505

The ID of the backup.

SourceClusterId String cl-0000g3mvy******5cj

The ID of the source SAP HANA instance.

VolumeId Integer 0

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.

DatabaseName String BWD

The name of the database.

Phase String restart

The recovery phase.

ClusterId String cl-000923yu******p00j4

The ID of the SAP HANA instance that is restored.

DatabaseRestoreId Long 1644038961030

The ID of the database recovery.

State String successful

The recovery status. This value is obtained from SAP HANA.

Source String PRD@H4P

The name of the source system. This parameter indicates the name of the source database that is restored. Format: <Source database name>@SID.

MaxPhase Integer 4

The maximum recovery phase. This value is obtained from SAP HANA.

EndTime Long 1634356382

The time when the restore job ends. This value is a UNIX timestamp. Unit: seconds.

StartTime Long 1636970413

The time when the restore job starts. This value is a UNIX timestamp. Unit: seconds.

BackupPrefix String INC_DATA_BACKUP

The backup prefix.

RestoreId String r-000c1en183ayn9sesgqh

The ID of the restore job.

LogPosition Long 0

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.

RecoveryPointInTime Long 1649851200

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. HBR restores the database to a state closest to the specified point in time.

MaxProgress Long 1

The maximum progress. This value is obtained from SAP HANA.

UseCatalog Boolean false

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 return value is false, HBR finds the backup file based on the specified prefix and then restores the backup file.

Examples

Sample requests

http(s)://[Endpoint]/?Action=DescribeHanaRestores
&VaultId=v-000au6bq******mpu
&ClusterId=cl-000b******soejg
&PageNumber=1
&PageSize=10
&RestoreId=r-0007o3vqfukfe92hvf13
&DatabaseName=SYSTEMDB
&BackupId=1632754800158
&RestoreStatus=COMPLETE
&ResourceGroupId=rg-acfm4ebtpkzx7zy
&Common request parameters

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

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

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "7DEFC897-8F05-5C05-912C-C9A9510FBFF1",
  "Success" : true,
  "Code" : "200",
  "Message" : "successful",
  "PageNumber" : 1,
  "PageSize" : 10,
  "TotalCount" : 19,
  "HanaRestore" : [ {
    "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

For a list of error codes, visit the API Error Center.