すべてのプロダクト
Search

このプロダクト

    :CreateRestoreJob

    ドキュメントセンター

    :CreateRestoreJob

    最終更新日:Jul 30, 2026

    復元ジョブを作成します。

    操作説明

    • 選択したスナップショットと復元先に基づいて復元ジョブを作成します。

    • データソースタイプと復元先のデータソースタイプは同じである必要があります。

    今すぐお試しください

    この 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:CreateRestoreJob

    create

    *すべてのリソース。

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    RestoreType

    string

    必須

    復元先のデータソースタイプ。有効な値:

    • ECS_FILE: ECS ファイルに復元します。

    • OSS: Alibaba Cloud OSS に復元します。

    • NAS: Alibaba Cloud NAS に復元します。

    • COMMON_FILE_SYSTEM: CPFS に復元します。

    • OTS_TABLE: Alibaba Cloud OTS に復元します。

    • UDM_ECS_ROLLBACK: Alibaba Cloud ECS インスタンスに復元します (フルコピー移行)。

    ECS_FILE
    VaultId

    string

    任意

    バックアップスナップショットが属するバックアップボールトの ID。

    v-*********************
    SnapshotId

    string

    任意

    バックアップスナップショットの ID。

    s-********************
    SnapshotHash

    string

    任意

    バックアップスナップショットのハッシュ値。

    f2fe...
    SourceType

    string

    必須

    データソースタイプ。有効な値:

    • ECS_FILE: ECS ファイルを復元します。

    • OSS: Alibaba Cloud OSS を復元します。

    • NAS: Alibaba Cloud NAS を復元します。

    • COMMON_FILE_SYSTEM: CPFS に復元します。

    • OTS_TABLE: Alibaba Cloud OTS に復元します。

    • UDM_ECS: Alibaba Cloud ECS インスタンスに復元します (フルコピー移行)。

    ECS_FILE
    Options

    string

    任意

    復元ジョブのパラメーター。

    {\"includes\":[],\"excludes\":[],\"conflictPolicy\":\"OVERWRITE_EXISTING\"}
    TargetFileSystemId

    string

    任意

    このパラメーターは、RestoreType が NAS に設定されている場合にのみ有効です。復元先のファイルシステム ID。

    005494
    TargetCreateTime

    integer

    任意

    このパラメーターは、RestoreType が NAS に設定されている場合にのみ有効です。送信先ファイルシステムの作成時間。この値は UNIX タイムスタンプです。単位: 秒。

    1554347313
    TargetPath

    string

    任意

    このパラメーターは、RestoreType が ECS_FILE に設定されている場合にのみ有効です。復元先のファイルパス。

    C:\
    TargetBucket

    string

    任意

    このパラメーターは、RestoreType が OSS に設定されている場合にのみ有効です。送信先 OSS バケットの名前。

    hbr-backup-oss
    TargetPrefix

    string

    任意

    このパラメーターは、RestoreType が OSS に設定されている場合にのみ有効です。復元先のオブジェクトプレフィックス。

    hbr
    UdmDetail

    object

    任意

    このパラメーターは、SourceType が UDM_ECS に設定されている場合にのみ有効です。フルコピー移行バックアップの詳細。このパラメーターは JSON 文字列です。詳細は RestoreType の値によって異なります。

    • UDM_ECS_DISK: ECS クラウドディスクのクローン。

      • targetInstanceId: 文字列タイプ、必須。クローンされたクラウドディスクがアタッチされるターゲット ECS インスタンスのインスタンス ID。

      • diskCategory: 文字列タイプ、必須。ターゲットクラウドディスクのタイプ。

      • diskPerformanceLevel: 文字列タイプ。diskCategory が essd に設定されている場合、このパラメーターはクラウドディスクのパフォーマンスレベル (PL) を指定します。有効な値: PL0、PL1、PL2、PL3。デフォルト値: PL1。

    • UDM_ECS_DISK_ROLLBACK: ECS クラウドディスクの復元。

      • sourceInstanceId: 文字列タイプ、必須。ソース ECS インスタンスのインスタンス ID。

      • foreceRestore: bool タイプ。デフォルト値: false。強制的に復元するかどうかを指定します。foreceRestore が true に設定されている場合、バックアップされたクラウドディスクが元の ECS インスタンスからアンマウントされているか、新しい ECS インスタンスにアタッチされている場合でも、復元ジョブはクラウドディスクを復元します。慎重に操作してください。

      • bootAfterRestore: bool タイプ。デフォルト値: false。復元後に ECS インスタンスを起動するかどうかを指定します。

    • UDM_ECS: ECS フルコピーのクローン。

      • bootAfterRestore: bool タイプ。デフォルト値: false。復元後に ECS インスタンスを起動するかどうかを指定します。

      • diskCategory: 文字列タイプ、必須。ターゲットクラウドディスクのタイプ。

      • diskPerformanceLevel: 文字列タイプ。diskCategory が essd に設定されている場合、このパラメーターはクラウドディスクのパフォーマンスレベル (PL) を指定します。有効な値: PL0、PL1、PL2、PL3。デフォルト値: PL1。

      • instanceType: 文字列タイプ、必須。ターゲット ECS インスタンスのインスタンスタイプ。

      • restoredNetwork: 文字列タイプ、必須。ターゲット ECS インスタンスの vSwitch ID。

      • securityGroup: 文字列タイプ、必須。ターゲット ECS インスタンスのセキュリティグループ ID。

      • restoredName: 文字列タイプ、必須。ターゲット ECS インスタンスのインスタンス名。

      • restoredHostName: 文字列タイプ、必須。ターゲット ECS インスタンスのホスト名。

      • allocatePublicIp: bool タイプ。デフォルト値: false。ターゲット ECS インスタンスにパブリック IP アドレスを割り当てるかどうかを指定します。

      • privateIpAddress: 文字列タイプ。ターゲット ECS インスタンスの内部 IP アドレス。このパラメーターが指定されていない場合、DHCP を使用して IP アドレスがランダムに割り当てられます。

    • UDM_ECS_ROLLBACK: ECS フルコピーの復元。

      • sourceInstanceId: 文字列タイプ、必須。ソース ECS インスタンスのインスタンス ID。

      • forceRestore: bool タイプ。デフォルト値: false。強制的に復元するかどうかを指定します。foreceRestore が true に設定されている場合、バックアップされたクラウドディスクが元の ECS インスタンスからアンマウントされているか、新しい ECS インスタンスにアタッチされている場合でも、復元ジョブはクラウドディスクを復元します。慎重に操作してください。

      • bootAfterRestore: bool タイプ。デフォルト値: false。復元後に ECS インスタンスを起動するかどうかを指定します。

    {\"sourceInstanceId\":\"i-uf62te6pm3iwsyxyz66q\",\"bootAfterRestore\":false}
    UdmRegionId

    string

    任意

    このパラメーターは、SourceType が UDM_ECS に設定されている場合にのみ有効です。復元のターゲットリージョン。

    cn-shanghai
    TargetInstanceId

    string

    任意

    このパラメーターは、RestoreType が ECS_FILE に設定されている場合にのみ有効です。復元先の ECS インスタンス ID。

    i-*********************
    Include

    string

    任意

    復元するパス。このパス配下のすべてのファイルが復元されます。最大長: 255 文字。

    ["/home/alice/*.pdf", "/home/bob/*.txt"]
    Exclude

    string

    任意

    復元から除外するパス。このパス配下のすべてのファイルは復元されません。最大長: 255 文字。

    ["/var", "/proc"]
    TargetContainer

    string

    任意

    復元用のターゲットコンテナの詳細。

    {\"host\":\"k8s-node1\",\"hostPrefix\":\"/var/lib/kubelet/pods/4acb31fe-8577-40ff-bc8c-eccabd835f73/volumes/kubernetes.io~csi/pvc-b050b00e-ef17-4792-aab1-1642355cf1f4/mount\",\"pvPath\":\"/\"}
    InitiatedByAck

    boolean

    任意

    操作がコンテナサービスによって呼び出されたかどうかを指定します。デフォルト値: false。

    false
    TargetContainerClusterId

    string

    任意

    復元用のターゲットコンテナクラスターの ID。

    cc-000amjsc7o1h9506oob7
    TargetInstanceName

    string

    任意

    復元用のターゲット Tablestore インスタンスの名前。

    instancename
    TargetTableName

    string

    任意

    復元用の Tablestore 内のターゲットデータテーブルの名前。

    tablename
    TargetTime

    integer

    任意

    Tablestore データを復元するポイント時間。この値は UNIX タイムスタンプです。単位: 秒。

    1642496881
    OtsDetail OtsTableRestoreDetail

    任意

    Tablestore インスタンスの詳細。

    CrossAccountType

    string

    任意

    クロスアカウントバックアップタイプ。有効な値:

    • SELF_ACCOUNT: 現在のアカウント内でのバックアップ。

    • CROSS_ACCOUNT: クロスアカウントバックアップ。

    SELF_ACCOUNT
    CrossAccountUserId

    integer

    任意

    現在のアカウントによって管理されるクロスアカウントバックアップのソースアカウントの ID。

    158975xxxxx4625
    CrossAccountRoleName

    string

    任意

    現在のアカウントによって管理されるクロスアカウントバックアップのためにソースアカウントで作成された RAM ロールの名前。

    BackupRole
    FailbackDetail

    object

    任意

    ローカルホストへの復元の詳細。

    {"cpu":4,"extra":"{\"restoreVMNamePrefix\":\"627-\",\"dataCenterName\":\"SDDC-Datacenter\",\"dataStoreId\":\"datastore-50\",\"folderId\":\"group-v49\",\"resourcePoolId\":\"resgroup-46\",\"locationName\":\"vcenter.pc-uf600a******1.acvs.aliyuncs.com/SDDC-Datacenter/Workloads\",\"computeResourceName\":\"SDDC-Datacenter/Default_c-uf600a******\",\"dataStoreName\":\"Default_c-uf600a******/WorkloadDatastore\",\"networkMoReference\":\"DistributedVirtualPortgroup:dvportgroup-1001\",\"useHotAdd\":false}","instanceId":"i-2vc******z","memoryInMB":8192,"serverId":"0fdc0c86-eb92-4e05-91ab-eeaf9fb6ad01","uefiBoot":false}
    Edition

    string

    任意

    Cloud Backup 機能のエディション。有効な値:

    • STANDARD: Standard Edition。これがデフォルト値です。

    • BASIC: Essential Edition。現在、ECS ファイルバックアップ Essential Edition のみがサポートされています。

    STANDARD

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    Code

    string

    応答コード。値 200 は成功を示します。

    200
    Message

    string

    応答メッセージ。成功の場合は "successful" という値が返されます。失敗した場合はエラーメッセージが返されます。

    successful
    RequestId

    string

    リクエスト ID。

    473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
    Success

    boolean

    リクエストが成功したかどうかを示します。

    • true: リクエストが成功しました。

    • false: リクエストが失敗しました。

    true
    RestoreId

    string

    復元ジョブの ID。

    r-*********************

    例

    成功レスポンス

    JSONJSON

    {
  "Code": "200",
  "Message": "successful",
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "Success": true,
  "RestoreId": "r-*********************"
}

    エラーコード

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

    変更履歴

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