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

接口说明

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

调试

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

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

hbr:DescribeHanaRetentionSetting

get

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
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	integer	备份保留天数，若 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"
}

错误码

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

变更历史

更多信息，参考变更详情。