All Products
Search

This Product

    Cloud Backup:DescribeHanaRestores

    Document Center

    Cloud Backup:DescribeHanaRestores

    Last Updated:Mar 03, 2024

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

    Debugging

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

    Authorization information

    There is currently no authorization information disclosed in the API.

    Request parameters

    ParameterTypeRequiredDescriptionExample
    VaultIdstringNo

    The ID of the backup vault.

    		v-000au6bq******mpu
    ClusterIdstringYes

    The ID of the SAP HANA instance.

    		cl-000b******soejg
    PageNumberintegerNo

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

    		1
    PageSizeintegerNo

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

    		10
    RestoreIdstringNo

    The ID of the restore job.

    		r-0007o3vqfukfe92hvf13
    DatabaseNamestringNo

    The name of the database.

    		SYSTEMDB
    BackupIdlongNo

    The ID of the backup.

    		1632754800158
    RestoreStatusstringNo

    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.
    		COMPLETE
    ResourceGroupIdstringNo

    The ID of the resource group.

    		rg-acfm4ebtpkzx7zy

    Response parameters

    ParameterTypeDescriptionExample
    object

    The request body.

    RequestIdstring

    The ID of the request.

    		7DEFC897-8F05-5C05-912C-C9A9510FBFF1
    Successboolean

    Indicates whether the call is successful. Valid values:

    • true: The call is successful.
    • false: The call fails.
    		true
    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
    PageNumberinteger

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

    		1
    PageSizeinteger

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

    		10
    TotalCountinteger

    The total number of returned entries.

    		19
    HanaRestoreobject []

    The information about restore jobs.

    Statusstring

    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.
    		COMPLETE
    ReachedTimelong

    The point in time at which the database is restored.

    		1635315505
    VaultIdstring

    The ID of the backup vault.

    		v-000g9acf******gta
    CurrentPhaseinteger

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

    		2
    ClearLogboolean

    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
    Messagestring

    The details of the recovery phase.

    		SQL Error 448 - recovery could not be completed:
    CheckAccessboolean

    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.
    		true
    Modestring

    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.
    		RECOVERY_TO_SPECIFIC_BACKUP
    SystemCopyboolean

    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
    CurrentProgresslong

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

    		1
    UseDeltaboolean

    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.

    		true
    BackupIDlong

    The ID of the backup.

    		1635315505
    SourceClusterIdstring

    The ID of the source SAP HANA instance.

    		cl-0000g3mvy******5cj
    VolumeIdinteger

    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
    DatabaseNamestring

    The name of the database.

    		BWD
    Phasestring

    The recovery phase.

    		restart
    ClusterIdstring

    The ID of the SAP HANA instance that is restored.

    		cl-000923yu******p00j4
    DatabaseRestoreIdlong

    The ID of the database recovery.

    		1644038961030
    Statestring

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

    		successful
    Sourcestring

    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
    MaxPhaseinteger

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

    		4
    EndTimelong

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

    		1634356382
    StartTimelong

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

    		1636970413
    BackupPrefixstring

    The backup prefix.

    		INC_DATA_BACKUP
    RestoreIdstring

    The ID of the restore job.

    		r-000c1en183ayn9sesgqh
    LogPositionlong

    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
    RecoveryPointInTimelong

    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.

    		1649851200
    MaxProgresslong

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

    		1
    UseCatalogboolean

    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.

    		false

    Examples

    Sample success responses

    JSONformat

    {
  "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

    For a list of error codes, visit the Service error codes.

    Change history

    Change timeSummary of changesOperation
    No change history