文档

DescribeHanaRestores - 查询符合条件的SAP HANA恢复任务

更新时间:

查询符合条件的SAP HANA恢复任务。

调试

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

授权信息

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

请求参数

名称类型必填描述示例值
VaultIdstring

备份仓库 ID。

v-000au6bq******mpu
ClusterIdstring

SAP HANA 实例 ID。

cl-000b******soejg
PageNumberinteger

分页页码。从 1 开始,默认值为 1。

1
PageSizeinteger

分页大小。最小值为 1,最大值为 99,默认值为 10。

10
RestoreIdstring

恢复任务 ID。

r-0007o3vqfukfe92hvf13
DatabaseNamestring

数据库名称。

SYSTEMDB
BackupIdlong

备份 ID。

1632754800158
RestoreStatusstring

恢复任务状态。

  • RUNNING:运行中
  • COMPLETE:成功
  • PARTIAL_COMPLETE:部分成功
  • FAILED:失败
  • CANCELED:已取消
  • EXPIRED:已超时
COMPLETE
ResourceGroupIdstring

资源组 ID。

rg-acfm4ebtpkzx7zy

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

7DEFC897-8F05-5C05-912C-C9A9510FBFF1
Successboolean

请求是否成功。

  • true:成功
  • false:失败
true
Codestring

返回码,200 表示成功。

200
Messagestring

返回信息描述,成功一般返回 successful,错误时会返回相应错误信息。

successful
PageNumberinteger

分页页码。从 1 开始,默认值为 1。

1
PageSizeinteger

分页大小。最小值为 1,最大值为 99,默认值为 10。

10
TotalCountinteger

总记录数。

19
HanaRestoreobject []

恢复任务列表。

Statusstring

恢复任务状态。

  • RUNNING:运行中
  • COMPLETE:成功
  • PARTIAL_COMPLETE:部分成功
  • FAILED:失败
  • CANCELED:已取消
  • EXPIRED:已超时
COMPLETE
ReachedTimelong

恢复的实际时间点。

1635315505
VaultIdstring

备份仓库 ID。

v-000g9acf******gta
CurrentPhaseinteger

当前恢复阶段,该值直接从 SAP HANA 获取。

2
ClearLogboolean

恢复后,日志条目将从日志区中删除。初始化日志区域,如果不想恢复驻留在日志区中的日志段,请选择 true,否则选择 false。

true
Messagestring

恢复阶段详情。

SQL Error 448 - recovery could not be completed:
CheckAccessboolean

检查差异和日志备份可用性。

  • true:在恢复开始时,系统会检查所需的差异备份和日志备份是否都可用。 如果缺少差异备份或日志备份,在更改数据之前会停止恢复。
  • false:不开启检查。
true
Modestring

恢复方式。

  • RECOVERY_TO_MOST_RECENT: 将数据库恢复到已备份的最近可用状态。
  • RECOVERY_TO_POINT_IN_TIME:将数据库恢复到特定时间点。
  • RECOVERY_TO_SPECIFIC_BACKUP:将数据库恢复到指定的数据库备份。
  • RECOVERY_TO_LOG_POSITION:将数据库还原到指定日志位置。
RECOVERY_TO_SPECIFIC_BACKUP
SystemCopyboolean

是否是跨实例恢复。

  • true:跨实例恢复
  • false:非跨实例恢复
true
CurrentProgresslong

当前进度,该值直接从 SAP HANA 获取。

1
UseDeltaboolean

是否使用差异备份。如果您需要使用差异备份或增量备份执行恢复,请选择 true。如果选择在不使用差异备份或增量备份的情况下执行恢复,则使用日志备份进行恢复。

true
BackupIDlong

备份 ID。

1635315505
SourceClusterIdstring

源 SAP HANA 实例 ID。

cl-0000g3mvy******5cj
VolumeIdinteger

要恢复的 Volume ID。仅选择RECOVERY_TO_LOG_POSITION恢复方式时有效。

0
DatabaseNamestring

数据库的名称。

BWD
Phasestring

恢复阶段。

restart
ClusterIdstring

待恢复的 SAP HANA 实例 ID。

cl-000923yu******p00j4
DatabaseRestoreIdlong

数据库恢复 ID。

1644038961030
Statestring

状态,该值直接从 SAP HANA 获取。

successful
Sourcestring

源系统名。表示需要恢复的源数据库名,格式为源数据库名@SID

PRD@H4P
MaxPhaseinteger

最大阶段,该值直接从 SAP HANA 获取。

4
EndTimelong

恢复任务结束时间。UNIX 时间,单位为秒。

1634356382
StartTimelong

恢复任务开始时间。UNIX 时间,单位为秒。

1636970413
BackupPrefixstring

备份前缀。

INC_DATA_BACKUP
RestoreIdstring

恢复任务 ID。

r-000c1en183ayn9sesgqh
LogPositionlong

日志位置,仅选择RECOVERY_TO_LOG_POSITION恢复方式时有效。

0
RecoveryPointInTimelong

选择需要恢复到的时间点。仅选择RECOVERY_TO_POINT_IN_TIME恢复方式时有效,系统会将数据库恢复到离这个时间最近的状态。

1649851200
MaxProgresslong

最大进度,该值直接从 SAP HANA 获取。

1
UseCatalogboolean

是否从 Catalog 中查找备份。仅选择RECOVERY_TO_SPECIFIC_BACKUP恢复方式时有效。如果不使用 Catalog,需要指定一个备份前缀,混合云备份服务会根据备份前缀进行恢复。

false

示例

正常返回示例

JSON格式

{
  "RequestId": "7DEFC897-8F05-5C05-912C-C9A9510FBFF1",
  "Success": true,
  "Code": "200",
  "Message": "successful",
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 19,
  "HanaRestore": {
    "HanaRestores": [
      {
        "Status": "COMPLETE",
        "ReachedTime": 1635315505,
        "VaultId": "v-000g9acf******gta",
        "CurrentPhase": 2,
        "ClearLog": true,
        "Message": "SQL Error 448 - recovery could not be completed:",
        "CheckAccess": true,
        "Mode": "RECOVERY_TO_SPECIFIC_BACKUP",
        "SystemCopy": true,
        "CurrentProgress": 1,
        "UseDelta": true,
        "BackupID": 1635315505,
        "SourceClusterId": "cl-0000g3mvy******5cj",
        "VolumeId": 0,
        "DatabaseName": "BWD",
        "Phase": "restart",
        "ClusterId": "cl-000923yu******p00j4",
        "DatabaseRestoreId": 1644038961030,
        "State": "successful",
        "Source": "PRD@H4P",
        "MaxPhase": 4,
        "EndTime": 1634356382,
        "StartTime": 1636970413,
        "BackupPrefix": "INC_DATA_BACKUP",
        "RestoreId": "r-000c1en183ayn9sesgqh",
        "LogPosition": 0,
        "RecoveryPointInTime": 1649851200,
        "MaxProgress": 1,
        "UseCatalog": false
      }
    ]
  }
}

错误码

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

变更历史

变更时间变更内容概要操作
暂无变更历史
  • 本页导读 (1)
文档反馈