All Products
Search
Document Center

Hybrid Backup Recovery:DescribeHanaBackupPlans

Last Updated:Nov 14, 2022

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

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
VaultIdstringNo

The ID of the backup vault.

v-000i4lg4kz******ahl
ClusterIdstringYes

The ID of the SAP HANA instance.

cl-000chxz******lz7bk
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.

SYSTEMDB
ResourceGroupIdstringNo

The ID of the resource group.

rg-acfmvywqfey5njq

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

F029C1C7-26B6-5ADD-A73E-D85CCD7C73A9
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
TotalCountlong

The total number of returned entries.

6
HanaBackupPlansarray

The details of the backup plan.

object

The details of the backup plan.

VaultIdstring

The ID of the backup vault.

v-000csihw82pqkd7hcjws
BackupPrefixstring

The backup prefix.

COMPLETE_DATA_BACKUP
Schedulestring

The backup policy. Format: I|{startTime}|{interval}. The system runs the first backup job at a point in time that is specified in the {startTime} parameter and the subsequent backup jobs at an interval that is specified in the {interval} parameter. The system does not run a backup job before the specified point in time. Each backup job, except the first one, starts only after the previous backup job is completed. For example, I|1631685600|P1D specifies that the system runs the first backup job at 14:00:00 on September 15, 2021 and the subsequent backup jobs once a day.

  • startTime: the time at which the system starts to run a backup job. The time follows the UNIX time format. Unit: seconds.
  • interval: the interval at which the system runs a backup job. The interval follows the ISO 8601 standard. For example, PT1H indicates an interval of 1 hour. P1D indicates an interval of one day.
I|1602673264|P1D
DatabaseNamestring

The name of the database.

SYSTEMDB
BackupTypestring

The backup type. Valid values:

  • COMPLETE: full backup
  • INCREMENTAL: incremental backup
  • DIFFERENTIAL: differential backup
COMPLETE
Disabledboolean

Indicates whether the backup plan is disabled. Valid values:

  • true: The backup plan is disabled.
  • false: The backup plan is enabled.
false
PlanIdstring

The ID of the backup plan.

pl-0000tnyndg3ne5m4ubeu
ClusterIdstring

The ID of the SAP HANA instance.

cl-0002scknka*****
PlanNamestring

The name of the backup plan.

plan-20220118-141153

Example

Request example

http(s)://[Endpoint]/?Action=DescribeHanaBackupPlans
&VaultId=v-000i4lg4kz******ahl
&ClusterId=cl-000chxz******lz7bk
&PageNumber=1
&PageSize=10
&DatabaseName=SYSTEMDB
&ResourceGroupId=rg-acfmvywqfey5njq
&Common request parameters

Normal return example

JSONFormat

{
  "RequestId": "F029C1C7-26B6-5ADD-A73E-D85CCD7C73A9",
  "Success": true,
  "Code": "200",
  "Message": "successful",
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 6,
  "HanaBackupPlans": [
    {
      "VaultId": "v-000csihw82pqkd7hcjws",
      "BackupPrefix": "COMPLETE_DATA_BACKUP",
      "Schedule": "I|1602673264|P1D",
      "DatabaseName": "SYSTEMDB",
      "BackupType": "COMPLETE",
      "Disabled": true,
      "PlanId": "pl-0000tnyndg3ne5m4ubeu",
      "ClusterId": "cl-0002scknka*****",
      "PlanName": "plan-20220118-141153"
    }
  ]
}

Error codes

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