DescribeHanaRetentionSetting - Query SAP HANA backup retention period - Cloud Backup

Operation description

To query backup parameters, call DescribeHanaBackupSetting.
Cloud Backup deletes expired Backint and file backup catalogs and data. Deleted catalogs and data cannot be restored. 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:DescribeHanaRetentionSetting

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
VaultId	string	Yes	The ID of the backup vault.	v-000ii8t******ntrt2
ClusterId	string	Yes	The ID of the SAP HANA instance.	cl-0002ys1i******wwtf
DatabaseName	string	No	The database name.	C4P

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	280DD872-EE25-52E8-9CB4-491067173DD0
VaultId	string	The ID of the backup vault.	v-0006wkn7******zkn
Schedule	string	The retention period update policy. Format: `I\|{startTime}\|{interval}`. The retention period is updated at the specified interval from the start time. startTime: the backup job start time in UNIX timestamp format. Unit: seconds. interval: the backup job interval in ISO 8601 format. For example, PT1H indicates 1 hour and P1D indicates 1 day.	I\|0\|P1D
Success	boolean	Indicates whether the request was successful. Valid values: true false	true
DatabaseName	string	The database name.	Q01
Disabled	boolean	Indicates whether the backup is permanently retained. Valid values: true: The backup is permanently retained. false: The backup is retained for the specified number of days.	false
Code	string	The response code. Status code 200 indicates success.	200
RetentionDays	integer	The backup retention period in days. Takes effect only when Disabled is set to false.	3650
Message	string	The returned message. Returns "successful" for successful requests, or an error message for failed requests.	successful
ClusterId	string	The ID of the SAP HANA instance.	cl-0003jyv******fsku5m

Examples

Success response

JSON format

{
  "RequestId": "280DD872-EE25-52E8-9CB4-491067173DD0",
  "VaultId": "v-0006wkn7******zkn",
  "Schedule": "I|0|P1D",
  "Success": true,
  "DatabaseName": "Q01",
  "Disabled": false,
  "Code": "200",
  "RetentionDays": 3650,
  "Message": "successful",
  "ClusterId": "cl-0003jyv******fsku5m"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.