Todos os produtos
Search
Central de documentação

Resource Orchestration Service:ALIYUN::HBR::RestoreJob

Última atualização: Jun 27, 2026

O recurso ALIYUN::HBR::RestoreJob crie um trabalho de restauração.

Sintaxe

{
  "Type": "ALIYUN::HBR::RestoreJob",
  "Properties": {
    "SnapshotId": String,
    "TargetClientId": String,
    "TargetPath": String,
    "SourceType": String,
    "SourceClientId": String,
    "TargetInstanceId": String,
    "VaultId": String,
    "SourceInstanceId": String,
    "RestoreType": String
  }
}

Propriedades

PropriedadeTipoObrigatórioEditávelDescriçãoRestrição
SnapshotIdStringSimNãoID do snapshot.Nenhuma
TargetClientIdStringSimNãoID do cliente de destino.Obrigatório se RestoreType for FILE.
TargetPathStringSimNãoCaminho de restauração dos dados de backup.Exemplo: /.
SourceTypeStringSimNãoTipo do arquivo de source.Valores válidos:
  • FILE: arquivo em máquina local.
  • ECS_FILE: arquivo em instância ECS.
SourceClientIdStringSimNãoID do cliente de source.Obrigatório se SourceType for FILE.
TargetInstanceIdStringSimNãoID da instância ECS de destino.Obrigatório se RestoreType for ECS_FILE.
VaultIdStringSimNãoCofre de backup onde o cliente de source está implantado.Nenhuma
SourceInstanceIdStringSimNãoID da instância ECS de source.Obrigatório se SourceType for ECS_FILE.
RestoreTypeStringSimNãoTipo do arquivo após a restauração.Valores válidos:
  • FILE: arquivo em máquina local.
  • ECS_FILE: arquivo em instância ECS.

Parâmetros de resposta

Fn::GetAtt

  • Status: status do trabalho de restauração.

  • SourceType: tipo do arquivo de source.

  • RestoreId: ID do trabalho de restauração.

  • ErrorMessage: mensagem de erro do trabalho de restauração.

  • RestoreType: tipo do arquivo após a restauração.

Exemplos

Formato JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "SnapshotId": {
      "Type": "String",
      "Description": "Snapshot ID"
    },
    "TargetClientId": {
      "Type": "String",
      "Description": "Target client ID. It should be provided when RestoreType=FILE."
    },
    "TargetPath": {
      "Type": "String",
      "Description": "Target path. For instance, \"/\"."
    },
    "SourceType": {
      "Type": "String",
      "Description": "Source type",
      "AllowedValues": [
        "FILE",
        "ECS_FILE"
      ]
    },
    "SourceClientId": {
      "Type": "String",
      "Description": "Source client ID. It should be provided when SourceType=FILE."
    },
    "TargetInstanceId": {
      "Type": "String",
      "Description": "Source client ID. It should be provided when RestoreType=ECS_FILE."
    },
    "VaultId": {
      "Type": "String",
      "Description": "Vault ID"
    },
    "SourceInstanceId": {
      "Type": "String",
      "Description": "Source instance ID. It should be provided when SourceType=ECS_FILE."
    },
    "RestoreType": {
      "Type": "String",
      "Description": "Restore type",
      "AllowedValues": [
        "FILE",
        "ECS_FILE"
      ]
    }
  },
  "Resources": {
    "RestoreJob": {
      "Type": "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": {
    "Status": {
      "Description": "Restore job status",
      "Value": {
        "Fn::GetAtt": [
          "RestoreJob",
          "Status"
        ]
      }
    },
    "SourceType": {
      "Description": "Source type",
      "Value": {
        "Fn::GetAtt": [
          "RestoreJob",
          "SourceType"
        ]
      }
    },
    "RestoreId": {
      "Description": "Restore job ID",
      "Value": {
        "Fn::GetAtt": [
          "RestoreJob",
          "RestoreId"
        ]
      }
    },
    "ErrorMessage": {
      "Description": "Error message of restore job",
      "Value": {
        "Fn::GetAtt": [
          "RestoreJob",
          "ErrorMessage"
        ]
      }
    },
    "RestoreType": {
      "Description": "Restore type",
      "Value": {
        "Fn::GetAtt": [
          "RestoreJob",
          "RestoreType"
        ]
      }
    }
  }
}

Formato YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
 SnapshotId:
  Type: String
  Description: Snapshot ID
 TargetClientId:
  Type: String
  Description: Target client ID. It should be provided when RestoreType=FILE.
 TargetPath:
  Type: String
  Description: 'Target path. For instance, "/".'
 SourceType:
  Type: String
  Description: Source type
  AllowedValues:
   - FILE
   - ECS_FILE
 SourceClientId:
  Type: String
  Description: Source client ID. It should be provided when SourceType=FILE.
 TargetInstanceId:
  Type: String
  Description: Source client ID. It should be provided when RestoreType=ECS_FILE.
 VaultId:
  Type: String
  Description: Vault ID
 SourceInstanceId:
  Type: String
  Description: Source instance ID. It should be provided when SourceType=ECS_FILE.
 RestoreType:
  Type: String
  Description: Restore type
  AllowedValues:
   - FILE
   - ECS_FILE
Resources:
 RestoreJob:
  Type: '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:
 Status:
  Description: Restore job status
  Value:
   'Fn::GetAtt':
    - RestoreJob
    - Status
 SourceType:
  Description: Source type
  Value:
   'Fn::GetAtt':
    - RestoreJob
    - SourceType
 RestoreId:
  Description: Restore job ID
  Value:
   'Fn::GetAtt':
    - RestoreJob
    - RestoreId
 ErrorMessage:
  Description: Error message of restore job
  Value:
   'Fn::GetAtt':
    - RestoreJob
    - ErrorMessage
 RestoreType:
  Description: Restore type
  Value:
   'Fn::GetAtt':
    - RestoreJob
    - RestoreType