DescribeHanaRetentionSetting - Cloud Backup - Alibaba Cloud Documentation Center

Queries the backup retention period of an SAP HANA database.

Operation description

If you want to query the backup parameters of a database, you can call the DescribeHanaBackupSetting operation.
HBR 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.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

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 name of the database.	C4P

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request.	280DD872-EE25-52E8-9CB4-491067173DD0
VaultId	string	The ID of the backup vault.	v-0006wkn7******zkn
Schedule	string	The policy to update the retention period. Format: `I\|{startTime}\|{interval}`, which indicates that the retention period is updated at an interval of {interval} starting from {startTime}. startTime: the time at which the system starts to update the retention period. The time follows the UNIX time format. Unit: seconds. interval: the interval at which the system updates the retention period. The interval follows the ISO 8601 standard. For example, PT1H indicates an interval of 1 hour. P1D indicates an interval of one day.	I\|0\|P1D
Success	boolean	Indicates whether the call is successful. Valid values: true: The call is successful. false: The call fails.	true
DatabaseName	string	The name of the database.	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 HTTP status code. The status code 200 indicates that the call is successful.	200
RetentionDays	long	The number of days for which the backup is retained. If the value of the Disabled parameter is false, the backup is retained for the number of days specified by this parameter.	3650
Message	string	The message that is returned. If the call is successful, "successful" is returned. If the call fails, an error message is returned.	successful
ClusterId	string	The ID of the SAP HANA instance.	cl-0003jyv******fsku5m

Examples

Sample success responses

JSONformat

{
  "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

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation

No change history