Automate SAP HANA Backup Retention with UpdateHanaRetentionSetting API - Cloud Backup - Alibaba Cloud - Cloud Backup

Operation description

If you want to update the backup parameters of a database, you can call the UpdateHanaBackupSetting operation.
Cloud Backup deletes the expired catalogs and data that are related to Backint and file backup. The deleted catalogs and data cannot be restored. We recommend that you set the retention period based on your business requirements.

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:UpdateHanaRetentionSetting

update

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
VaultId	string	Yes	The ID of the backup vault.	v-000fb0v2ly******k6
ClusterId	string	Yes	The ID of the SAP HANA instance.	cl-00024vyjj******srrq
Schedule	string	Yes	The policy to update the retention period. Format: `I\|{startTime}\|{interval}`. The retention period is updated at an interval of {interval} starting from {startTime}. 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, and P1D indicates an interval of one day.	I\|0\|P1D
RetentionDays	integer	Yes	The retention period of the backup data. Unit: days. If you set the Disabled parameter to false, the backup is retained for the number of days specified by this parameter.	90
Disabled	boolean	Yes	Specifies whether to permanently retain the backup. Valid values: true: The backup is permanently retained. false: The backup is retained for the specified number of days.	false
DatabaseName	string	Yes	The database name.	SYSTEMDB

Response elements

Element	Type	Description	Example
	object
Code	string	The response code. The status code 200 indicates that the request was successful.	200
Message	string	The returned message. If the request was successful, "successful" is returned. If the request failed, an error message is returned.	successful
RequestId	string	The request ID.	7BEE26EB-8EE3-57A0-A9DE-5FD700165DE5
Success	boolean	Indicates whether the request was successful. Valid values: true false	true

Examples

Success response

JSON format

{
  "Code": "200",
  "Message": "successful",
  "RequestId": "7BEE26EB-8EE3-57A0-A9DE-5FD700165DE5",
  "Success": true
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.