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

Resource Orchestration Service:ALIYUN::HBR::RestoreJob

最終更新日:Mar 17, 2025

ALIYUN::HBR::RestoreJobは、復元ジョブの作成に使用されます。

構文

{
  "タイプ": "ALIYUN::HBR::RestoreJob" 、
  "Properties": {
    "SnapshotId": String,
    "TargetClientId": 文字列、
    "TargetPath": 文字列、
    "SourceType": 文字列、
    "SourceClientId": 文字列、
    "TargetInstanceId": 文字列、
    "VaultId": 文字列、
    "SourceInstanceId": String,
    "RestoreType": 文字列
  }
}

プロパティ

プロパティデータ型必須編集可能説明制約条件
SnapshotIdString必須不可スナップショットチェーンの ID 。なし
TargetClientIdString必須不可宛先クライアントのID。このパラメーターは、RestoreTypeパラメーターがFILEに設定されている場合に必要です。
ターゲットパスString必須不可バックアップデータが復元されるパス。例: /
SourceTypeString必須不可ソースファイルのタイプ。有効な値:
  • FILE: オンプレミスのマシンに保存されているファイル。
  • ECS_FILE: ECSインスタンスに保存されているファイル。
SourceClientIdString必須不可送信元クライアントのID。このパラメーターは、SourceTypeパラメーターがFILEに設定されている場合に必要です。
TargetInstanceIdString必須不可移行先ECSインスタンスのID。このパラメーターは、RestoreTypeパラメーターがECS_FILEに設定されている場合に必要です。
VaultIdString必須不可ソースクライアントが展開されるバックアップコンテナー。なし
SourceInstanceIdString必須不可ソースECSインスタンスのID。このパラメーターは、SourceTypeパラメーターがECS_FILEに設定されている場合に必要です。
RestoreTypeString必須不可復元後のファイルのタイプ。有効な値:
  • FILE: オンプレミスのマシンに保存されているファイル。
  • ECS_FILE: ECSインスタンスに保存されているファイル。

レスポンスパラメーター

Fn::GetAtt

  • ステータス: 復元ジョブのステータス。
  • SourceType: ソースファイルのタイプ。
  • RestoreId: 復元ジョブのID。
  • ErrorMessage: 復元ジョブのエラーメッセージ。
  • RestoreType: 復元後のファイルのタイプ。

JSON 形式

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "SnapshotId": {
      "Type": "String",
      "Description": "スナップショットID"
    },
    "TargetClientId": {
      "Type": "String",
      "Description": "ターゲットクライアントID。 これは、RestoreType=FILEのときに提供されるべきである。
    },
    "TargetPath": {
      "Type": "String",
      "Description": "ターゲットパス。 たとえば、\"/\" 。
    },
    "SourceType": {
      "Type": "String",
      "Description": "ソースタイプ" 、
      "AllowedValues": [
        "ファイル" 、
        "ECS_FILE"
      ]
    },
    "SourceClientId": {
      "Type": "String",
      "Description": "ソースクライアントID。 これは、SourceType=FILEのときに提供されるべきである。
    },
    "TargetInstanceId": {
      "Type": "String",
      "Description": "ソースクライアントID。 これは、RestoreType=ECS_FILEのときに提供されるべきである。
    },
    "VaultId": {
      "Type": "String",
      "Description": "Vault ID"
    },
    "SourceInstanceId": {
      "Type": "String",
      "Description": "ソースインスタンスID。 これは、SourceType=ECS_FILEのときに提供されるべきである。
    },
    "RestoreType": {
      "Type": "String",
      "Description": "Restore type" 、
      "AllowedValues": [
        "ファイル" 、
        "ECS_FILE"
      ]
    }
  },
  "Resources": {
    "RestoreJob": {
      "タイプ": "ALIYUN::HBR::RestoreJob" 、
      "Properties": {
        "SnapshotId": {
          "Ref": "SnapshotId"
        },
        "TargetClientId": {
          "Ref": "TargetClientId"
        },
        "TargetPath": {
          "Ref": "TargetPath"
        },
        "SourceType": {
          "Ref": "SourceType"
        },
        "SourceClientId": {
          "Ref": "SourceClientId"
        },
        "TargetInstanceId": {
          "Ref": "TargetInstanceId"
        },
        "VaultId": {
          "Ref": "VaultId"
        },
        "SourceInstanceId": {
          "Ref": "SourceInstanceId"
        },
        "RestoreType": {
          "Ref": "RestoreType"
        }
      }
    }
  },
  "Outputs": {
    "状態":{
      "説明": "ジョブのステータスを復元" 、
      "Value": {
        "Fn::GetAtt": [
          "RestoreJob" 、
          「ステータス」
        ]
      }
    },
    "SourceType": {
      "Description": "ソースタイプ" 、
      "Value": {
        "Fn::GetAtt": [
          "RestoreJob" 、
          "SourceType"
        ]
      }
    },
    "RestoreId": {
      "説明": "ジョブIDを復元" 、
      "Value": {
        "Fn::GetAtt": [
          "RestoreJob" 、
          "RestoreId"
        ]
      }
    },
    "ErrorMessage": {
      「説明」: 「復元ジョブのエラーメッセージ」、
      "Value": {
        "Fn::GetAtt": [
          "RestoreJob" 、
          "エラーメッセージ"
        ]
      }
    },
    "RestoreType": {
      "Description": "Restore type" 、
      "Value": {
        "Fn::GetAtt": [
          "RestoreJob" 、
          「RestoreType」
        ]
      }
    }
  }
}

YAML形式

ROSTemplateFormatVersion: '2015-09-01'
パラメータ:
 SnapshotId:
  データ型:Strig
  説明: スナップショットID
 TargetClientId:
  データ型:Strig
  説明: ターゲットクライアントID。 RestoreType=FILEのときに指定する必要があります。
 TargetPath:
  データ型:Strig
  説明: 'ターゲットパス。 たとえば、"/".'
 SourceType:
  データ型:Strig
  説明: ソースタイプ
  AllowedValues:
   -ファイル
   -ECS_FILE
 SourceClientId:
  データ型:Strig
  説明: ソースクライアントID。 これは、SourceType=FILEのときに提供されるべきである。
 TargetInstanceId:
  データ型:Strig
  説明: ソースクライアントID。 RestoreType=ECS_FILEの場合に提供されるべきである。
 VaultId:
  データ型:Strig
  説明: Vault ID
 SourceInstanceId:
  データ型:Strig
  説明: ソースインスタンスID。 これは、SourceType=ECS_FILEのときに提供されるべきである。
 RestoreType:
  データ型:Strig
  説明: 復元タイプ
  AllowedValues:
   -ファイル
   -ECS_FILE
リソース:
 RestoreJob:
  タイプ: 'ALIYUN::HBR::RestoreJob'
  プロパティ:
   SnapshotId:
    参照: SnapshotId
   TargetClientId:
    参照: TargetClientId
   TargetPath:
    参照: TargetPath
   SourceType:
    参照: SourceType
   SourceClientId:
    参照: SourceClientId
   TargetInstanceId:
    参照: TargetInstanceId
   VaultId:
    参照: VaultId
   SourceInstanceId:
    参照: SourceInstanceId
   RestoreType:
    参照: RestoreType
出力:
 状態:
  説明: ジョブのステータスを復元する
  値:
   'Fn::GetAtt':
    -RestoreJob
    -ステータス
 SourceType:
  説明: ソースタイプ
  値:
   'Fn::GetAtt':
    -RestoreJob
    -SourceType
 RestoreId:
  説明: ジョブIDの復元
  値:
   'Fn::GetAtt':
    -RestoreJob
    -RestoreId
 エラーメッセージ:
  説明: 復元ジョブのエラーメッセージ
  値:
   'Fn::GetAtt':
    -RestoreJob
    -エラーメッセージ
 RestoreType:
  説明: 復元タイプ
  値:
   'Fn::GetAtt':
    -RestoreJob
    -RestoreType