Todos os produtos
Search

Este produto

    Cloud Backup:CreateBackupPlan

    Central de documentação

    Cloud Backup:CreateBackupPlan

    Última atualização: Jun 28, 2026

    Cria um plano de backup.

    Descrição da operação

    Importante

    • Chame esta API para usar recursos como a edição básica de backup de arquivos ECS, backup de disco em nuvem, backup de contêiner, a avaliação gratuita de backup do TableStore, arquivamento ou sincronização de dados.

    • Para usar a avaliação gratuita de 30 dias para backup do NAS ou backup do OSS, chame a operação CreateTrialBackupPlan.

    • Para usar os recursos padrão de backup de arquivos ECS, backup de arquivos locais, backup de instâncias ECS, backup do NAS, backup do OSS ou backup do CPFS, chame as operações CreatePolicyV2 e CreatePolicyBindings.

    • A execução de um plano de backup cria um job de backup para registrar seu progresso e resultado. Um job bem-sucedido gera um snapshot de backup, que você pode usar para criar um job de restauração.

    • Um plano de backup suporta apenas uma origem de dados.

    • Um plano de backup suporta apenas uma política de backup com um ciclo de intervalo fixo.

    • Um plano de backup pode fazer backup para apenas um repositório de backup.

    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:CreateBackupPlan

    create

    *All Resource

    *

    		 Nenhuma Nenhuma

    Parâmetros da solicitação

    Parâmetro

    Tipo

    Obrigatório

    Descrição

    Exemplo
    SourceType

    string

    Sim

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

    • ECS_FILE: Faz backup de arquivos de instâncias ECS.

    • OSS: Faz backup de buckets do OSS.

    • NAS: Faz backup de sistemas de arquivos NAS.

    • OTS: Faz backup de instâncias do Tablestore.

    • UDM_ECS: Faz backup de uma instância ECS inteira.

    • SYNC: Executa a sincronização de dados.

    ECS_FILE
    PlanName

    string

    Não

    O nome do plano de backup. O nome deve ter de 1 a 64 caracteres e ser exclusivo para cada tipo de origem de dados em um repositório de backup.

    planname
    BackupType

    string

    Não

    O tipo de backup. Defina o valor como COMPLETE, que especifica um backup completo.

    COMPLETE
    VaultId

    string

    Não

    O ID do repositório de backup.

    v-0006******q
    Schedule

    string

    Não

    A política de backup. O formato é I|{startTime}|{interval}. Isso especifica que um job de backup é executado em um intervalo de {interval}, começando em {startTime}. Jobs de backup atrasados não são repetidos. Se o job de backup anterior não estiver concluído, o próximo job de backup não será acionado. Por exemplo, I|1631685600|P1D indica que um job de backup é executado diariamente a partir das 14:00:00 de 15 de setembro de 2021.

    • startTime: a hora de início do backup, especificada como um timestamp UNIX em segundos.

    • interval: o intervalo de backup, especificado no formato de duração ISO 8601. Por exemplo, PT1H representa uma hora e P1D representa um dia.

    I|1602673264|P1D
    Retention

    integer

    Não

    O período de retenção do backup, em dias. O valor mínimo é 1.

    7
    ClusterId

    string

    Não

    O ID do grupo de clientes que executa o job de sincronização de dados. Este parâmetro é obrigatório apenas se SourceType estiver definido como SYNC.

    cl-***************
    FileSystemId

    string

    Não

    O ID do sistema de arquivos. Este parâmetro é obrigatório apenas se SourceType estiver definido como NAS.

    005494
    CreateTime

    integer

    Não

    A hora em que o sistema de arquivos foi criado, especificada como um timestamp UNIX em segundos. Este parâmetro é obrigatório apenas se SourceType estiver definido como NAS.

    1607436917
    Bucket

    string

    Não

    O nome do bucket do OSS. Este parâmetro é obrigatório apenas se SourceType estiver definido como OSS.

    hbr-backup-oss
    Prefix

    string

    Não

    O prefixo dos objetos para backup. Se especificado, apenas os objetos com esse prefixo serão incluídos no backup. Este parâmetro é obrigatório apenas se SourceType estiver definido como OSS.

    oss-prefix
    InstanceId

    string

    Não

    O ID da instância ECS. Este parâmetro é obrigatório apenas se SourceType estiver definido como ECS_FILE.

    i-m5e*****6q
    Detail

    object

    Não

    Os detalhes de um backup de instância inteira, especificados como uma string JSON.

    • snapshotGroup: especifica se deve ser usado um grupo consistente com snapshot. Este recurso está disponível apenas se todos os discos da instância forem ESSDs.

    • appConsistent: especifica se a consistência de aplicativo deve ser ativada. Isso deve ser usado com os parâmetros preScriptPath e postScriptPath.

    • preScriptPath: o caminho para o script de pré-congelamento.

    • postScriptPath: o caminho para o script de pós-descongelamento.

    {\"EnableFsFreeze\":true,\"appConsistent\":false,\"postScriptPath\":\"\",\"preScriptPath\":\"\",\"snapshotGroup\":true,\"timeoutInSeconds\":60}
    UdmRegionId

    string

    Não

    A região em que a instância ECS está localizada.

    cn-shanghai
    SpeedLimit

    string

    Não

    A política de modelagem de tráfego para o backup. Formato: {start}:{end}:{bandwidth}. Você pode especificar várias regras separadas por barras verticais (|). Os intervalos de tempo especificados não podem se sobrepor. Este parâmetro é obrigatório apenas se SourceType estiver definido como ECS_FILE.

    • start: a hora de início.

    • end: a hora de término.

    • bandwidth: o limite de largura de banda, em KB/s.

    0:24:5120
    Include

    string

    Não

    Os caminhos dos arquivos e diretórios a serem incluídos no backup. O caminho pode ter até 255 caracteres. Este parâmetro é obrigatório apenas se SourceType estiver definido como ECS_FILE.

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

    string

    Não

    Os caminhos dos arquivos e diretórios a serem excluídos do backup. O caminho pode ter até 255 caracteres. Este parâmetro é obrigatório apenas se SourceType estiver definido como ECS_FILE.

    ["/var", "/proc"]
    Options

    string

    Não

    Especifica se o Serviço de Cópia de Sombra de Volume (VSS) do Windows deve ser usado para garantir a consistência dos dados. Este parâmetro é obrigatório apenas se SourceType estiver definido como ECS_FILE.

    • Este recurso está disponível apenas para instâncias ECS Windows.

    • Se os dados na origem do backup forem alterados durante o backup, defina este parâmetro como {"UseVSS":true} para garantir a consistência dos dados.

    • Se você ativar o VSS, não poderá fazer backup de vários diretórios de arquivos ao mesmo tempo.

    {"UseVSS":false}
    DataSourceId

    string

    Não

    O ID da origem de dados. Este parâmetro é obrigatório apenas se SourceType estiver definido como SYNC.

    ds-****************
    Path

    array

    Não

    Os caminhos de backup.

    string

    Não

    Um caminho de backup. O caminho pode ter até 65.536 caracteres. As seguintes regras se aplicam aos caminhos de backup:

    • Se você não usar curingas (*), poderá especificar até 20 caminhos.

    • Se você usar curingas (*), poderá especificar apenas um caminho. Padrões de curinga como /*/* são suportados.

    • Cada caminho deve ser um caminho absoluto.

    • Se o VSS estiver ativado, você não poderá usar vários caminhos, caminhos UNC, curingas ou exclusões de arquivos.

    • Quando um caminho UNC é usado, VSS, curingas e exclusões de arquivos não são suportados. Se a origem do backup contiver caminhos UNC, as ACLs do Windows não serão incluídas no backup.

    ["/home"]
    Rule

    array<object>

    Não

    As regras de backup.

    object

    Não

    Uma regra de backup.

    DestinationRetention

    integer

    Não

    O período de retenção do backup com redundância geográfica, em dias.

    7
    Schedule

    string

    Não

    A política de backup. O formato é I|{startTime}|{interval}. Isso especifica que um job de backup é executado em um intervalo de {interval}, começando em {startTime}. Jobs de backup atrasados não são repetidos. Se o job de backup anterior não estiver concluído, o próximo job de backup não será acionado. Por exemplo, I|1631685600|P1D indica que um job de backup é executado diariamente a partir das 14:00:00 de 15 de setembro de 2021.

    No formato, startTime é a hora de início do backup (um timestamp UNIX em segundos) e interval é o intervalo de backup (no formato de duração ISO 8601). Por exemplo, PT1H representa uma hora e P1D representa um dia.

    I|1602673264|P1D
    Retention

    integer

    Não

    O período de retenção do backup, em dias.

    7
    Disabled

    boolean

    Não

    Especifica se a regra deve ser desativada.

    false
    DoCopy

    boolean

    Não

    Especifica se a redundância geográfica deve ser ativada para o backup.

    false
    DestinationRegionId

    string

    Não

    O ID da região de destino para redundância geográfica.

    cn-hangzhou
    RuleName

    string

    Não

    O nome da regra.

    rule-test-name
    BackupType

    string

    Não

    O tipo de backup.

    COMPLETE
    InstanceName

    string

    Não

    O nome da instância do Tablestore.

    instancename
    OtsDetail OtsDetail

    Não

    Os detalhes da instância do Tablestore.

    CrossAccountType

    string

    Não

    O tipo de backup entre contas. Valores válidos:

    • SELF_ACCOUNT: faz backup de dados na mesma conta.

    • CROSS_ACCOUNT: faz backup de dados em uma conta diferente.

    Valores válidos:

    • SELF_ACCOUNT :

      SELF_ACCOUNT.

    • CROSS_ACCOUNT :

      CROSS_ACCOUNT.

    CROSS_ACCOUNT
    CrossAccountUserId

    integer

    Não

    O ID da conta de origem da Alibaba Cloud para um backup entre contas.

    15897534xxxx4625
    CrossAccountRoleName

    string

    Não

    O nome da função RAM que é criada na conta de origem.

    BackupRole
    KeepLatestSnapshots

    integer

    Não

    Especifica se os snapshots de backup mais recentes devem ser retidos permanentemente.

    • 0: não reter.

    • 1: reter.

    Valores válidos:

    • 0 :

      No

    • 1 :

      Sim.

    1
    DestSourceType

    string

    Não

    O tipo de origem de dados de destino. Este parâmetro é obrigatório apenas se SourceType estiver definido como SYNC.

    OSS
    DestDataSourceId

    string

    Não

    O ID da origem de dados de destino. Este parâmetro é obrigatório apenas se SourceType estiver definido como SYNC.

    ds-*********************

    DestDataSourceDetail

    object

    Não

    Os detalhes da origem de dados de destino. Este parâmetro é obrigatório apenas se SourceType estiver definido como SYNC.

    {\"prefix\":\"/\"}
    ChangeListPath

    string

    Não

    A configuração da lista de alterações para sincronização incremental de arquivos. Este parâmetro é obrigatório apenas se SourceType estiver definido como SYNC.

    {"dataSourceId": "ds-123456789", "path": "/changelist"}
    Disabled

    boolean

    Não

    Especifica se o plano de backup deve ser desativado após a criação.

    true
    Edition

    string

    Não

    A edição do plano de backup. Os valores válidos são BASIC e STANDARD. Valor padrão: STANDARD.

    STANDARD

    Elementos de resposta

    Elemento

    Tipo

    Descrição

    Exemplo

    object

    Os dados retornados.

    Code

    string

    O código da resposta. Um valor 200 indica que a solicitação foi bem-sucedida.

    200
    Message

    string

    A mensagem da resposta. Se a solicitação for bem-sucedida, o valor será successful. Se a solicitação falhar, uma mensagem de erro será retornada.

    successful
    RequestId

    string

    O ID da solicitação.

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

    string

    O ID do plano de backup.

    plan-*********************
    Success

    boolean

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

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

    • false: a solicitação falhou.

    true

    Exemplos

    Resposta de sucesso

    JSON formato

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

    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.