All Products
Search

This Product

    Cloud Backup:DescribeHanaBackupsAsync

    Document Center

    Cloud Backup:DescribeHanaBackupsAsync

    Last Updated:Aug 28, 2026

    Queries SAP HANA backups that meet specified conditions.

    Operation description

    This operation is asynchronous. After you call DescribeHanaBackupsAsync, call the DescribeTask operation to query the final result.

    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

    No authorization for this operation. If you encounter issues with this operation, contact technical support.

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    VaultId

    string

    No

    The ID of the backup vault.

    v-000270c******pi81
    ClusterId

    string

    Yes

    The ID of the SAP HANA instance.

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

    string

    No

    The database name.

    BPD
    Mode

    string

    No

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

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

    boolean

    No

    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
    Source

    string

    No

    The name of the source system. Specify the name of the source database to restore in the <Source database name>@SID format.

    P01@HP1
    SourceClusterId

    string

    No

    The ID of the source SAP HANA instance.

    cl-0000g3m******5cj
    IncludeDifferential

    boolean

    No

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

    • true: includes differential backups.

    • false: excludes differential backups.

    false
    IncludeIncremental

    boolean

    No

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

    • true: includes incremental backups.

    • false: excludes incremental backups.

    true
    IncludeLog

    boolean

    No

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

    • true: includes log backups.

    • false: excludes log backups.

    true
    UseBackint

    boolean

    No

    Specifies whether Backint is used. Valid values:

    • true: Backint is used.

    • false: Backint is not used.

    false
    ResourceGroupId

    string

    No

    The ID of the resource group.

    rg-acfmz7mced2ldhy

    Response elements

    Element

    Type

    Description

    Example

    object

    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
    RequestId

    string

    The request ID.

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

    string

    The ID of the asynchronous job. Call the DescribeTask operation to query the execution result of the asynchronous job.

    t-0006xmbplrqebt9dhkth
    Success

    boolean

    Indicates whether the request was successful. Valid values:

    • true

    • false

    true

    Examples

    Success response

    JSON format

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

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.