すべてのプロダクト
Search

このプロダクト

    :DescribeHanaRestores

    ドキュメントセンター

    :DescribeHanaRestores

    最終更新日:Dec 23, 2025

    指定された条件を満たす 1 つ以上の SAP HANA 復元ジョブを照会します。

    今すぐお試しください

    この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

    テスト

    RAM 認証

    下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

    • アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。

    • API：アクションを具体的に実行するための API。

    • アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。

    • リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。

      • リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。

      • リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。

    • 条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。

    • 依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    hbr:DescribeHanaRestores

    get

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    VaultId

    string

    任意

    バックアップボールトの ID。

    v-000au6bq******mpu
    ClusterId

    string

    必須

    SAP HANA インスタンスの ID。

    cl-000b******soejg
    PageNumber

    integer

    任意

    ページ番号。ページは 1 から始まります。デフォルト値：1。

    1
    PageSize

    integer

    任意

    1 ページあたりのエントリ数。有効値：1～99。デフォルト値：10。`

    10
    RestoreId

    string

    任意

    復元ジョブの ID。

    r-0007o3vqfukfe92hvf13
    DatabaseName

    string

    任意

    データベース名。

    SYSTEMDB
    BackupId

    integer

    任意

    バックアップ ID。

    1632754800158
    RestoreStatus

    string

    任意

    復元ジョブのステータス。有効な値：

    • RUNNING：ジョブは実行中です。

    • COMPLETE：ジョブは完了しました。

    • PARTIAL_COMPLETE：ジョブは部分的に完了しました。

    • FAILED：ジョブは失敗しました。

    • CANCELED：ジョブはキャンセルされました。

    • EXPIRED：ジョブはタイムアウトしました。

    COMPLETE
    ResourceGroupId

    string

    任意

    リソースグループの ID。

    rg-acfm4ebtpkzx7zy

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    RequestId

    string

    リクエスト ID。

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

    boolean

    リクエストが成功したかどうかを示します。有効な値：

    • true

    • false

    true
    Code

    string

    応答コード。状態コード 200 は、リクエストが成功したことを示します。

    200
    Message

    string

    返されたメッセージ。リクエストが成功した場合、「successful」が返されます。リクエストが失敗した場合、エラーメッセージが返されます。

    successful
    PageNumber

    integer

    ページ番号。ページは 1 から始まります。デフォルト値：1。

    1
    PageSize

    integer

    1 ページあたりのエントリ数。有効値：1～99。デフォルト値：10。

    10
    TotalCount

    integer

    返されたエントリの総数。

    19
    HanaRestore

    object

    HanaRestores

    array<object>

    復元ジョブに関する情報。

    object

    復元ジョブ。

    Status

    string

    復元ジョブのステータス。有効な値：

    • RUNNING：ジョブは実行中です。

    • COMPLETE：ジョブは完了しました。

    • PARTIAL_COMPLETE：ジョブは部分的に完了しました。

    • FAILED：ジョブは失敗しました。

    • CANCELED：ジョブはキャンセルされました。

    • EXPIRED：ジョブはタイムアウトしました。

    COMPLETE
    ReachedTime

    integer

    データベースが復元される時点。

    1635315505
    VaultId

    string

    バックアップボールトの ID。

    v-000g9acf******gta
    CurrentPhase

    integer

    現在のリカバリフェーズ。この値は SAP HANA から取得されます。

    2
    ClearLog

    boolean

    ログエントリが復元された後、ログエリアからすべてのログエントリが削除されるかどうかを示します。有効な値は true と false です。戻り値が false の場合、ログエントリが復元された後、すべてのログエントリがログエリアから削除されます。

    true
    Message

    string

    リカバリフェーズの詳細。

    SQL Error 448 - recovery could not be completed:
    CheckAccess

    boolean

    差分バックアップとログバックアップが検証されるかどうかを示します。有効な値：

    • true：Cloud Backup は、復元ジョブが開始される前に、必要な差分バックアップとログバックアップが利用可能かどうかを確認します。差分バックアップまたはログバックアップが利用できない場合、Cloud Backup は復元ジョブを開始しません。

    • false：Cloud Backup は、復元ジョブが開始される前に、必要な差分バックアップとログバックアップが利用可能かどうかを確認しません。

    true
    Mode

    string

    リカバリモード。有効な値：

    • RECOVERY_TO_MOST_RECENT：データベースは、バックアップされた最新の利用可能な状態に復元されます。

    • RECOVERY_TO_POINT_IN_TIME：データベースは、指定された時点に復元されます。

    • RECOVERY_TO_SPECIFIC_BACKUP：データベースは、指定されたバックアップに復元されます。

    • RECOVERY_TO_LOG_POSITION：データベースは、指定されたログポジションに復元されます。

    RECOVERY_TO_SPECIFIC_BACKUP
    SystemCopy

    boolean

    データベースが別のインスタンスに復元されるかどうかを示します。有効な値：

    • true：データベースは別のインスタンスに復元されます。

    • false：データベースは同じインスタンス内に復元されます。

    true
    CurrentProgress

    integer

    現在の進行状況。この値は SAP HANA から取得されます。

    1
    UseDelta

    boolean

    差分バックアップまたは増分バックアップを使用してデータベースを復元するかどうかを示します。有効な値は true と false です。戻り値が true の場合、Cloud Backup は差分バックアップまたは増分バックアップを使用してデータベースを復元します。戻り値が false の場合、Cloud Backup はログバックアップを使用してデータベースを復元します。

    true
    BackupID

    integer

    バックアップ ID。

    1635315505
    SourceClusterId

    string

    ソース SAP HANA インスタンスの ID。

    cl-0000g3mvy******5cj
    VolumeId

    integer

    復元されるボリュームの ID。このパラメーターは、Mode パラメーターの値が RECOVERY_TO_LOG_POSITION の場合にのみ返されます。

    0
    DatabaseName

    string

    データベース名。

    BWD
    Phase

    string

    リカバリフェーズ。

    restart
    ClusterId

    string

    復元される SAP HANA インスタンスの ID。

    cl-000923yu******p00j4
    DatabaseRestoreId

    integer

    データベースリカバリの ID。

    1644038961030
    State

    string

    リカバリステータス。この値は SAP HANA から取得されます。

    successful
    Source

    string

    ソースシステムの名前。このパラメーターは、復元されるソースデータベースの名前を示します。フォーマット：<ソースデータベース名>@SID。

    PRD@H4P
    MaxPhase

    integer

    最大リカバリフェーズ。この値は SAP HANA から取得されます。

    4
    EndTime

    integer

    復元ジョブが終了する時間。この値は UNIX タイムスタンプです。単位：秒。

    1634356382
    StartTime

    integer

    復元ジョブが開始される時間。この値は UNIX タイムスタンプです。単位：秒。

    1636970413
    BackupPrefix

    string

    バックアッププレフィックス。

    INC_DATA_BACKUP
    RestoreId

    string

    復元ジョブの ID。

    r-000c1en183ayn9sesgqh
    LogPosition

    integer

    データベースが復元されるログポジション。このパラメーターは、Mode パラメーターの値が RECOVERY_TO_LOG_POSITION の場合にのみ返されます。

    0
    RecoveryPointInTime

    integer

    データベースが復元される時点。このパラメーターは、Mode パラメーターの値が RECOVERY_TO_POINT_IN_TIME の場合にのみ返されます。Cloud Backup は、指定された時点に最も近い状態にデータベースを復元します。

    1649851200
    MaxProgress

    integer

    最大進行状況。この値は SAP HANA から取得されます。

    1
    UseCatalog

    boolean

    カタログバックアップを使用してデータベースを復元するかどうかを示します。このパラメーターは、Mode パラメーターの値が RECOVERY_TO_SPECIFIC_BACKUP の場合にのみ返されます。戻り値が false の場合、Cloud Backup は指定されたプレフィックスに基づいてバックアップファイルを見つけ、そのバックアップファイルを復元します。

    false

    例

    成功レスポンス

    JSONJSON

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

    エラーコード

    完全なリストについては、「エラーコード」をご参照ください。

    変更履歴

    完全なリストについては、「変更履歴」をご参照ください。