All Products
Search
Document Center

Hybrid Backup Recovery:DescribeHanaBackupsAsync

Last Updated:Nov 14, 2022

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

Operation Description

After you call the DescribeHanaBackupsAsync operation to query the SAP HANA backups that meet the specified conditions, call the DescribeTask operation to query the execution result of the asynchronous job.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
VaultIdstringNo

The ID of the backup vault.

v-000270c******pi81
ClusterIdstringYes

The ID of the SAP HANA instance.

cl-00098******yuqvu
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
DatabaseNamestringNo

The name of the database.

BPD
ModestringNo

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_SPECIFIC_BACKUP
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.

1649851200
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
SystemCopybooleanNo

Specifies whether to restore the database to a different instance. Valid values:

  • true: restores the database to a different instance.
  • false: restores the database within the same instance.
true
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.

P01@HP1
SourceClusterIdstringNo

The ID of the source SAP HANA instance.

cl-0000g3m******5cj
IncludeDifferentialbooleanNo

Specifies whether to include differential backups in the query results. Valid values:

  • true: includes differential backups.
  • false: excludes differential backups.
false
IncludeIncrementalbooleanNo

Specifies whether to include incremental backups in the query results. Valid values:

  • true: includes incremental backups.
  • false: excludes incremental backups.
true
IncludeLogbooleanNo

Specifies whether to include log backups in the query results. Valid values:

  • true: includes log backups.
  • false: excludes log backups.
true
UseBackintbooleanNo

Specifies whether Backint is used. Valid values:

  • true: Backint is used.
  • false: Backint is not used.
false
ResourceGroupIdstringNo

The ID of the resource group.

rg-acfmz7mced2ldhy

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.

31F97233-8563-563D-8880-914B00EEA928
TaskIdstring

The ID of the asynchronous job. You can call the DescribeTask operation to query the execution result of the asynchronous job.

t-0006xmbplrqebt9dhkth
Successboolean

Indicates whether the call is successful. Valid values:

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

Example

Request example

http(s)://[Endpoint]/?Action=DescribeHanaBackupsAsync
&VaultId=v-000270c******pi81
&ClusterId=cl-00098******yuqvu
&PageNumber=1
&PageSize=10
&DatabaseName=BPD
&Mode=RECOVERY_TO_SPECIFIC_BACKUP
&RecoveryPointInTime=1649851200
&LogPosition=0
&VolumeId=0
&SystemCopy=true
&Source=P01@HP1
&SourceClusterId=cl-0000g3m******5cj
&IncludeDifferential=false
&IncludeIncremental=true
&IncludeLog=true
&UseBackint=false
&ResourceGroupId=rg-acfmz7mced2ldhy
&Common request parameters

Normal return example

JSONFormat

{
  "Code": "200",
  "Message": "successful",
  "RequestId": "31F97233-8563-563D-8880-914B00EEA928",
  "TaskId": "t-0006xmbplrqebt9dhkth",
  "Success": true
}

Error codes

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