调用DescribeHanaBackupsAsync查询符合条件的SAPHANA备份_云备份(Cloud Backup)-阿里云帮助中心

查询一个或多个符合条件的SAP HANA备份。

接口说明

调用 DescribeHanaBackupsAsync 查询符合条件的 SAP HANA 备份后，请调用 DescribeTask 接口查询最终结果。

调试

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

调试

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
hbr:DescribeHanaBackupsAsync	get	全部资源 *	无	无

请求参数

名称	类型	必填	描述	示例值
VaultId	string	否	备份仓库 ID。	v-000270c******pi81
ClusterId	string	是	SAP HANA 实例 ID。	cl-00098******yuqvu
PageNumber	integer	否	分页页码，从 1 开始，默认值为 1。	1
PageSize	integer	否	分页大小，最小值为 1，最大值为 99，默认值为 10。	10
DatabaseName	string	否	数据库名称。	BPD
Mode	string	否	恢复方式。 RECOVERY_TO_MOST_RECENT：最近时间，将数据库恢复到已备份的最近可用状态。 RECOVERY_TO_POINT_IN_TIME：指定时间，将数据库恢复到特定时间点。 RECOVERY_TO_SPECIFIC_BACKUP：指定备份，将数据库恢复到指定的数据库备份。 RECOVERY_TO_LOG_POSITION：日志位置，将数据库还原到指定日志位置。	RECOVERY_TO_SPECIFIC_BACKUP
RecoveryPointInTime	long	否	选择需要恢复到的时间点。仅选择RECOVERY_TO_POINT_IN_TIME恢复方式时有效，系统会将数据库恢复到离这个时间最近的状态。	1649851200
LogPosition	long	否	日志位置，仅选择RECOVERY_TO_LOG_POSITION恢复方式时有效。	0
VolumeId	integer	否	要恢复的 Volume ID。仅选择RECOVERY_TO_LOG_POSITION恢复方式时有效。	0
SystemCopy	boolean	否	是否是跨实例恢复。 true：跨实例恢复 false：非跨实例恢复	true
Source	string	否	源系统名。表示需要恢复的源数据库名，格式为`源数据库名@SID`。	P01@HP1
SourceClusterId	string	否	源 SAP HANA 实例 ID。	cl-0000g3m******5cj
IncludeDifferential	boolean	否	是否包括差异备份。 true：包括差异备份 false：不包括差异备份	false
IncludeIncremental	boolean	否	是否包括增量备份。 true：包括增量备份 false：不包括增量备份	true
IncludeLog	boolean	否	是否包括日志备份。 true：包括日志备份 false：不包括日志备份	true
UseBackint	boolean	否	是否使用 Backint。 true：使用 Backint false：不使用 Backint	false
ResourceGroupId	string	否	资源组 ID。	rg-acfmz7mced2ldhy

返回参数

名称	类型	描述	示例值
	object
Code	string	返回码，200 表示成功。	200
Message	string	返回信息描述，成功一般返回 successful，错误时会返回相应错误信息。	successful
RequestId	string	请求 ID。	31F97233-8563-563D-8880-914B00EEA928
TaskId	string	异步任务 ID。可以通过调用 DescribeTask 获取任务结果。	t-0006xmbplrqebt9dhkth
Success	boolean	请求是否成功。 true：成功 false：失败	true

示例

正常返回示例

JSON格式

{
  "Code": "200",
  "Message": "successful",
  "RequestId": "31F97233-8563-563D-8880-914B00EEA928",
  "TaskId": "t-0006xmbplrqebt9dhkth",
  "Success": true
}

错误码

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

变更历史

变更时间	变更内容概要	操作

暂无变更历史