すべてのプロダクト
Search
ドキュメントセンター

:CreateRestoreJob

最終更新日:Jan 21, 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

*All Resource

*

なし なし

リクエストパラメーター

パラメーター

必須 / 任意

説明

RestoreType

string

必須

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

  • ECS_FILE:Elastic Compute Service (ECS) ファイルを復元します。

  • OSS:データを Object Storage Service (OSS) に復元します。

  • NAS:データを NAS に復元します。

  • COMMON_FILE_SYSTEM:データを Cloud Parallel File System (CPFS) に復元します。

  • OTS_TABLE:データを Tablestore に復元します。

  • UDM_ECS_ROLLBACK:ECS インスタンス全体をロールバックします。

ECS_FILE

VaultId

string

任意

バックアップスナップショットが属するバックアップリポジトリの ID。

v-*********************

SnapshotId

string

任意

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

s-********************

SnapshotHash

string

任意

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

f2fe...

SourceType

string

必須

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

  • ECS_FILE:ECS ファイル。

  • OSS:OSS データ。

  • NAS:NAS データ。

  • COMMON_FILE_SYSTEM:CPFS データ。

  • OTS_TABLE:Tablestore データ。

  • UDM_ECS:ECS インスタンス全体。

ECS_FILE

Options

string

任意

復元ジョブのパラメーターを指定します。

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

TargetFileSystemId

string

任意

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

005494

TargetCreateTime

integer

任意

宛先ファイルシステムが作成された時刻。このパラメーターは、RestoreTypeNAS に設定されている場合にのみ有効です。

1554347313

TargetPath

string

任意

復元の宛先パス。このパラメーターは、RestoreTypeECS_FILE に設定されている場合にのみ有効です。

C:\

TargetBucket

string

任意

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

hbr-backup-oss

TargetPrefix

string

任意

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

hbr

UdmDetail

object

任意

インスタンス全体のバックアップの詳細。このパラメーターは JSON 文字列であり、SourceType が UDM_ECS に設定されている場合にのみ有効です。このパラメーターの内容は、RestoreType の値によって異なります:

  • UDM_ECS_DISK:ECS ディスクをクローンします。
    • targetInstanceId:文字列、必須。クローンされたディスクがアタッチされる宛先 ECS インスタンスの ID。

    • diskCategory:文字列、必須。宛先ディスクのタイプ。

    • diskPerformanceLevel:文字列。diskCategory が essd に設定されている場合のディスクのパフォーマンスレベル。有効な値は PL0、PL1、PL2、PL3 です。デフォルト値は PL1 です。

  • UDM_ECS_DISK_ROLLBACK:ECS ディスクを復旧します。
    • sourceInstanceId:文字列、必須。ソース ECS インスタンスの ID。

    • forceRestore:ブール値。デフォルト値は false です。ディスクを強制的に復旧するかどうかを指定します。forceRestore を true に設定すると、ディスクが元の ECS インスタンスからアンインストールされたり、新しい ECS インスタンスにアタッチされたりした場合でも、ディスクは復旧されます。このオプションは注意して使用してください。

    • bootAfterRestore:ブール値。デフォルト値は false です。復旧後に ECS インスタンスを起動するかどうかを指定します。

  • UDM_ECS:ECS インスタンス全体をクローンします。
    • bootAfterRestore:ブール値。デフォルト値は false です。復旧後に ECS インスタンスを起動するかどうかを指定します。

    • diskCategory:文字列、必須。宛先ディスクのタイプ。

    • diskPerformanceLevel:文字列。diskCategory が essd に設定されている場合のディスクのパフォーマンスレベル。有効な値は PL0、PL1、PL2、PL3 です。デフォルト値は PL1 です。

    • instanceType:文字列、必須。宛先 ECS インスタンスのインスタンスタイプ。

    • restoredNetwork:文字列、必須。宛先 ECS インスタンスの vSwitch の ID。

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

    • restoredName:文字列、必須。宛先 ECS インスタンスの名前。

    • restoredHostName:文字列、必須。宛先 ECS インスタンスのホスト名。

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

    • privateIpAddress:文字列。宛先 ECS インスタンスのプライベート IP アドレス。このパラメーターを指定しない場合、DHCP によってランダムな IP アドレスが割り当てられます。

  • UDM_ECS_ROLLBACK:ECS インスタンス全体をロールバックします。
    • sourceInstanceId:文字列、必須。ソース ECS インスタンスの ID。

    • forceRestore:ブール値。デフォルト値は false です。インスタンスを強制的に復旧するかどうかを指定します。forceRestore を true に設定すると、ディスクが元の ECS インスタンスからアンインストールされたり、新しい ECS インスタンスにアタッチされたりした場合でも、ディスクは復旧されます。このオプションは注意して使用してください。

    • bootAfterRestore:ブール値。デフォルト値は false です。復旧後に ECS インスタンスを起動するかどうかを指定します。

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

UdmRegionId

string

任意

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

cn-shanghai

TargetInstanceId

string

任意

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

i-*********************

Include

string

任意

すべてのドキュメントを復元するパス。パスの長さは 255 文字を超えることはできません。

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

Exclude

string

任意

復元ジョブから除外するファイルのパス。指定されたパス内のすべてのファイルは復元されません。値は文字列の JSON 配列です。各パスの長さは最大 255 文字です。

["/var", "/proc"]

TargetContainer

string

任意

宛先コンテナーの詳細。このパラメーターは JSON 文字列です。

{\"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

任意

復元ジョブが Container Service for Kubernetes (ACK) によって開始されたかどうかを指定します。デフォルト値は 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:Basic Edition。このエディションは、基本的な ECS ファイルバックアッププランでのみ利用可能です。

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-*********************"
}

エラーコード

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

変更履歴

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