All Products
Search
Document Center

Hybrid Backup Recovery:UpdateHanaBackupPlan

Last Updated:Nov 14, 2022

Updates the settings of an SAP HANA backup plan.

Operation Description

  • A backup plan defines the data source, backup policy, and other configurations. After you execute a backup plan, a backup job is generated to record the backup progress and the backup result. If a backup job is completed, a backup snapshot is generated. You can use a backup snapshot to create a restore job.
  • You can specify only one type of data source in a backup plan.
  • You can specify only one interval as a backup cycle in a backup plan.
  • Each backup plan allows you to back up data to only one backup vault.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
VaultIdstringYes

The ID of the backup vault.

v-0000rcw******5c6
ClusterIdstringYes

The ID of the SAP HANA instance.

cl-0005dhe******f38
PlanIdstringYes

The ID of the backup plan.

pl-000br3cm4dqvmtph7cul
PlanNamestringNo

The name of the backup plan.

plan-20211109-162411
SchedulestringNo

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 must follow the UNIX time format. Unit: seconds.
  • interval: the interval at which the system runs a backup job. The interval must follow the ISO 8601 standard. For example, PT1H specifies an interval of 1 hour. P1D specifies an interval of one day.
I|1602673264|P1D
BackupPrefixstringNo

The backup prefix.

COMPLETE_DATA_BACKUP
ResourceGroupIdstringNo

The ID of the resource group.

rg-acfmze36euddwjq

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.

F23BCC67-09B4-582C-AE70-C813C8548DCC
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=UpdateHanaBackupPlan
&VaultId=v-0000rcw******5c6
&ClusterId=cl-0005dhe******f38
&PlanId=pl-000br3cm4dqvmtph7cul
&PlanName=plan-20211109-162411
&Schedule=I|1602673264|P1D
&BackupPrefix=COMPLETE_DATA_BACKUP
&ResourceGroupId=rg-acfmze36euddwjq
&Common request parameters

Normal return example

JSONFormat

{
  "Code": "200",
  "Message": "successful",
  "RequestId": "F23BCC67-09B4-582C-AE70-C813C8548DCC",
  "Success": true
}

Error codes

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