Todos os produtos
Search

Este produto

    Cloud Backup:CreateRestoreJob

    Central de documentação

    Cloud Backup:CreateRestoreJob

    Última atualização: Jun 28, 2026

    Cria um trabalho de restauração.

    Descrição da operação

    • Esta operação cria um trabalho de restauração a partir de um snapshot de backup selecionado para um destino de restauração especificado.

    • A origem e o destino devem ter o mesmo tipo de fonte de dados.

    Experimente agora

    Experimente esta API no OpenAPI Explorer, sem necessidade de assinatura manual. Chamadas bem-sucedidas geram automaticamente código SDK correspondente aos seus parâmetros. Faça o download com segurança de credenciais integrada para uso local.

    Testar

    Autorização RAM

    A tabela abaixo descreve a autorização necessária para chamar esta API. Você pode defini-la em uma política do Resource Access Management (RAM). As colunas da tabela estão detalhadas abaixo:

    • Ação: As ações que podem ser usadas no elemento Action das instruções de política de permissão do RAM para conceder permissões para executar a operação.

    • API: A API que você pode chamar para executar a ação.

    • Nível de acesso: O nível de acesso predefinido concedido para cada API. Valores válidos: create, list, get, update e delete.

    • Tipo de recurso: O tipo de recurso que suporta autorização para executar a ação. Indica se a ação suporta permissão em nível de recurso. O recurso especificado deve ser compatível com a ação. Caso contrário, a política será ineficaz.

      • Para APIs com permissões em nível de recurso, os tipos de recursos obrigatórios são marcados com um asterisco (*). Especifique o Nome de Recurso Alibaba Cloud (ARN) correspondente no elemento Resource da política.

      • Para APIs sem permissões em nível de recurso, é exibido como Todos os Recursos. Use um asterisco (*) no elemento Resource da política.

    • Chave de condição: As chaves de condição definidas pelo serviço. A chave permite controle granular, aplicando-se somente a ações ou a ações associadas a recursos específicos. Além das chaves de condição específicas do serviço, o Alibaba Cloud fornece um conjunto de chaves de condição comuns aplicáveis a todos os serviços compatíveis com RAM.

    • Ação dependente: As ações dependentes necessárias para executar a ação. Para concluir a ação, o usuário RAM ou a função RAM deve ter permissões para executar todas as ações dependentes.

    Ação

    Nível de acesso

    Tipo de recurso

    Chave de condição

    Ação dependente

    hbr:CreateRestoreJob

    create

    *All Resource

    *

    		 Nenhuma Nenhuma

    Parâmetros da solicitação

    Parâmetro

    Tipo

    Obrigatório

    Descrição

    Exemplo
    RestoreType

    string

    Sim

    O tipo da fonte de dados de destino. Valores válidos:

    • ECS_FILE: Restaura arquivos do Elastic Compute Service (ECS).

    • OSS: Restaura dados para o Object Storage Service (OSS).

    • NAS: Restaura dados para o NAS.

    • COMMON_FILE_SYSTEM: Restaura dados para o Cloud Parallel File System (CPFS).

    • OTS_TABLE: Restaura dados para o Tablestore.

    • UDM_ECS_ROLLBACK: Reverte uma instância ECS inteira.

    ECS_FILE
    VaultId

    string

    Não

    O ID do repositório de backup ao qual o snapshot de backup pertence.

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

    string

    Não

    O ID do snapshot de backup.

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

    string

    Não

    O valor de hash do snapshot de backup.

    f2fe...
    SourceType

    string

    Sim

    O tipo dos dados de origem. Valores válidos:

    • ECS_FILE: Arquivos do ECS.

    • OSS: Dados do OSS.

    • NAS: Dados do NAS.

    • COMMON_FILE_SYSTEM: Dados do CPFS.

    • OTS_TABLE: Dados do Tablestore.

    • UDM_ECS: Uma instância ECS inteira.

    ECS_FILE
    Options

    string

    Não

    Especifica os parâmetros para o trabalho de restauração.

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

    string

    Não

    O ID do sistema de arquivos de destino. Este parâmetro é válido apenas quando RestoreType está definido como NAS.

    005494
    TargetCreateTime

    integer

    Não

    O horário em que o sistema de arquivos de destino foi criado. Este parâmetro é válido apenas quando RestoreType está definido como NAS.

    1554347313
    TargetPath

    string

    Não

    O caminho de destino para a restauração. Este parâmetro é válido apenas quando RestoreType está definido como ECS_FILE.

    C:\
    TargetBucket

    string

    Não

    O nome do bucket do OSS de destino. Este parâmetro é válido apenas quando RestoreType está definido como OSS.

    hbr-backup-oss
    TargetPrefix

    string

    Não

    O prefixo do caminho de destino para os objetos que você deseja restaurar. Este parâmetro é válido apenas quando RestoreType está definido como OSS.

    hbr
    UdmDetail

    object

    Não

    Os detalhes do backup de toda a instância. Este parâmetro é uma string JSON e é válido apenas quando SourceType está definido como UDM_ECS. O conteúdo deste parâmetro varia com base no valor de RestoreType:

    • UDM_ECS_DISK: Clona um disco do ECS.

      • targetInstanceId: string, obrigatório. O ID da instância ECS de destino à qual o disco clonado está anexado.

      • diskCategory: string, obrigatório. O tipo do disco de destino.

      • diskPerformanceLevel: string. O nível de desempenho do disco quando diskCategory está definido como essd. Os valores válidos são PL0, PL1, PL2 e PL3. O valor padrão é PL1.

    • UDM_ECS_DISK_ROLLBACK: Recupera um disco do ECS.

      • sourceInstanceId: string, obrigatório. O ID da instância ECS de origem.

      • forceRestore: boolean. O valor padrão é false. Especifica se o disco deve ser recuperado à força. Se você definir forceRestore como true, o disco será recuperado mesmo que tenha sido desinstalado da instância ECS original ou anexado a uma nova instância ECS. Use esta opção com cautela.

      • bootAfterRestore: boolean. O valor padrão é false. Especifica se a instância ECS deve ser iniciada após a recuperação.

    • UDM_ECS: Clona uma instância ECS inteira.

      • bootAfterRestore: boolean. O valor padrão é false. Especifica se a instância ECS deve ser iniciada após a recuperação.

      • diskCategory: string, obrigatório. O tipo do disco de destino.

      • diskPerformanceLevel: string. O nível de desempenho do disco quando diskCategory está definido como essd. Os valores válidos são PL0, PL1, PL2 e PL3. O valor padrão é PL1.

      • instanceType: string, obrigatório. O tipo da instância ECS de destino.

      • restoredNetwork: string, obrigatório. O ID do vSwitch para a instância ECS de destino.

      • securityGroup: string, obrigatório. O ID do grupo de segurança para a instância ECS de destino.

      • restoredName: string, obrigatório. O nome da instância ECS de destino.

      • restoredHostName: string, obrigatório. O nome do host da instância ECS de destino.

      • allocatePublicIp: boolean. O valor padrão é false. Especifica se um endereço IP público deve ser atribuído à instância ECS de destino.

      • privateIpAddress: string. O endereço IP privado da instância ECS de destino. Se você não especificar este parâmetro, um endereço IP aleatório será atribuído pelo DHCP.

    • UDM_ECS_ROLLBACK: Reverte uma instância ECS inteira.

      • sourceInstanceId: string, obrigatório. O ID da instância ECS de origem.

      • forceRestore: boolean. O valor padrão é false. Especifica se a instância deve ser recuperada à força. Se você definir forceRestore como true, o disco será recuperado mesmo que tenha sido desinstalado da instância ECS original ou anexado a uma nova instância ECS. Use esta opção com cautela.

      • bootAfterRestore: boolean. O valor padrão é false. Especifica se a instância ECS deve ser iniciada após a recuperação.

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

    string

    Não

    A região de destino para a recuperação. Este parâmetro é válido apenas quando SourceType está definido como UDM_ECS.

    cn-shanghai
    TargetInstanceId

    string

    Não

    O ID da instância ECS de destino. Este parâmetro é válido apenas quando RestoreType está definido como ECS_FILE.

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

    string

    Não

    O caminho a partir do qual todos os arquivos serão restaurados. O caminho não pode exceder 255 caracteres de comprimento.

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

    string

    Não

    Os caminhos dos arquivos a serem excluídos do trabalho de restauração. Todos os arquivos nos caminhos especificados não serão restaurados. O valor é uma matriz JSON de strings. Cada caminho pode ter até 255 caracteres de comprimento.

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

    string

    Não

    Os detalhes do contêiner de destino. Este parâmetro é uma 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

    Não

    Especifica se o trabalho de restauração é iniciado pelo Container Service for Kubernetes (ACK). O valor padrão é false.

    false
    TargetContainerClusterId

    string

    Não

    O ID do cluster de contêineres de destino.

    cc-000amjsc7o1h9506oob7
    TargetInstanceName

    string

    Não

    O nome da instância do Tablestore de destino.

    instancename
    TargetTableName

    string

    Não

    O nome da tabela de destino na instância do Tablestore.

    tablename
    TargetTime

    integer

    Não

    O horário para o qual você deseja restaurar os dados do Tablestore. Este é um timestamp UNIX. Unidade: segundos.

    1642496881
    OtsDetail OtsTableRestoreDetail

    Não

    Os detalhes da instância do Tablestore.

    CrossAccountType

    string

    Não

    O tipo da restauração entre contas. Valores válidos:

    • SELF_ACCOUNT: Restaura dados dentro da mesma conta.

    • CROSS_ACCOUNT: Restaura dados de uma conta diferente.

    SELF_ACCOUNT
    CrossAccountUserId

    integer

    Não

    O ID da conta de origem que contém os dados de backup para uma restauração entre contas.

    158975xxxxx4625
    CrossAccountRoleName

    string

    Não

    O nome da função RAM que você cria na conta de origem para realizar uma restauração entre contas.

    BackupRole
    FailbackDetail

    object

    Não

    Especifica os detalhes de uma restauração local.

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

    Não

    A edição do Cloud Backup. Valores válidos:

    • STANDARD: Standard Edition. Este é o valor padrão.

    • BASIC: Basic Edition. Esta edição está disponível apenas para planos básicos de backup de arquivos do ECS.

    STANDARD

    Elementos de resposta

    Elemento

    Tipo

    Descrição

    Exemplo

    object

    Code

    string

    O código de retorno. Um valor 200 indica que a chamada foi bem-sucedida.

    200
    Message

    string

    A mensagem retornada. Se a chamada for bem-sucedida, "successful" será retornado. Se a chamada falhar, uma mensagem de erro será retornada.

    successful
    RequestId

    string

    O ID da solicitação.

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

    boolean

    Indica se a solicitação foi bem-sucedida.

    • true: A solicitação foi bem-sucedida.

    • false: A solicitação falhou.

    true
    RestoreId

    string

    O ID do trabalho de restauração.

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

    Exemplos

    Resposta de sucesso

    JSON formato

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

    Códigos de erro

    Consulte Códigos de Erro para uma lista completa.

    Notas de versão

    Consulte Notas de Versão para uma lista completa.