DescribeHanaRetentionSetting - 查询符合条件的SAP HANA数据库备份保留时间 - 混合云备份 HBR

查询数据库的保留时间。

接口说明

若要查询数据库的备份参数可以调用DescribeHanaBackupSetting。
SAP HANA备份保留时间到期后，备份服务会自动清理过期的BACKINT备份与文件备份相关的catalog记录以及数据，清理后不可恢复。请您根据实际情况谨慎配置备份保留时间。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
VaultId	string	是	备份仓库ID。	v-000ii8t******ntrt2
ClusterId	string	是	SAP HANA实例ID。	cl-0002ys1i******wwtf
DatabaseName	string	否	数据库名称。	C4P

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求ID。	280DD872-EE25-52E8-9CB4-491067173DD0
VaultId	string	备份仓库ID。	v-0006wkn7******zkn
Schedule	string	更新保留时间策略。可选格式：`I\|{startTime}\|{interval}`，表示从{startTime}开始每隔{interval}的时间更新一次保留时间。 startTime：备份起始时间，UNIX时间，单位秒。 interval： ISO8601时间间隔。例如：PT1H表示间隔一小时。P1D表示间隔一天。	I\|0\|P1D
Success	boolean	请求是否成功。 true：成功 false：失败	true
DatabaseName	string	数据库名称。	Q01
Disabled	boolean	备份是否永久保留。 true：永久保留 false：不永久保留，保留RetentionDays指定的天数。	false
Code	string	返回码，200表示成功。	200
RetentionDays	long	备份保留天数，若Disabled为false，则备份将保留该参数指定的天数。	3650
Message	string	返回信息描述，成功一般返回successful，错误时会返回相应错误信息。	successful
ClusterId	string	SAP HANA实例ID。	cl-0003jyv******fsku5m

示例

正常返回示例

JSON格式

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

错误码

访问错误中心查看更多错误码。