Update SAP HANA Backup Plans via UpdateHanaBackupPlan API - Cloud Backup - Alibaba Cloud - Cloud Backup

Operation description

A backup plan defines the data source, backup policy, and other configurations. When a backup plan runs, it generates a backup job that records the progress and result. A completed backup job produces a backup snapshot, which you can use to create a restore job.
Each backup plan supports only one type of data source.
Each backup plan supports only one fixed-interval backup cycle.
Each backup plan supports only one backup vault.

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

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

hbr:UpdateHanaBackupPlan

update

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
VaultId	string	Yes	The ID of the backup vault.	v-0000rcw******5c6
ClusterId	string	Yes	The ID of the SAP HANA instance.	cl-0005dhe******f38
PlanId	string	Yes	The ID of the backup plan.	pl-000br3cm4dqvmtph7cul
PlanName	string	No	The name of the backup plan.	plan-20211109-162411
Schedule	string	No	The backup policy. Format: `I\|{startTime}\|{interval}`. The first backup job runs at the time specified by {startTime}, and subsequent jobs run at the specified {interval}. No backup job runs before the start time, and each job starts only after the previous one completes. For example, `I\|1631685600\|P1D` starts the first backup at 14:00:00 on September 15, 2021 and runs subsequent backups 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
BackupPrefix	string	No	The backup prefix.	COMPLETE_DATA_BACKUP
ResourceGroupId	string	No	The ID of the resource group.	rg-acfmze36euddwjq

Response elements

Element	Type	Description	Example
	object
Code	string	The response code. Status code 200 indicates success.	200
Message	string	The returned message. A value of "successful" indicates success. Otherwise, an error message is returned.	successful
RequestId	string	The request ID.	F23BCC67-09B4-582C-AE70-C813C8548DCC
Success	boolean	Indicates whether the request was successful. Valid values: true false	true

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.