Todos os produtos
Search

Este produto

    Cloud Backup:CreateBackupJob

    Central de documentação

    Cloud Backup:CreateBackupJob

    Última atualização: Oct 26, 2026

    Cria um trabalho de backup manual.

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

    create

    *Todos os recursos.

    *

    		 Nenhuma Nenhuma

    Parâmetros da solicitação

    Parâmetro

    Tipo

    Obrigatório

    Descrição

    Exemplo
    JobName

    string

    Não

    O nome do trabalho de backup.

    k8s-backup-infra-20220131150046-hbr
    SourceType

    string

    Sim

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

    • UDM_ECS: backup de instância ECS.

    Valores válidos:

    • UDM_ECS :

      Backup de instância ECS.

    UDM_ECS
    Retention

    integer

    Não

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

    15
    InstanceId

    string

    Não

    Este parâmetro é obrigatório quando SourceType é definido como UDM_ECS. O ID da instância ECS.

    i-bp1xxxxxxxxxxxxxxysm
    Detail

    object

    Não

    As configurações de detalhes. Este parâmetro é obrigatório quando SourceType é definido como UDM_ECS. O valor é uma string de caracteres JSON.

    • doCopy: Especifica se a replicação entre regiões deve ser ativada.

    • destinationRegionId: A região de destino para a replicação entre regiões.

    • destinationRetention: O período de retenção dos pontos de backup de cópia entre regiões.

    • diskIdList: A lista de IDs de discos em nuvem para backup. Se este parâmetro for deixado vazio, todos os discos em nuvem serão submetidos a backup.

    • snapshotGroup: Especifica se um grupo de snapshots consistentes deve ser usado. Isso só entra em vigor quando todos os discos em nuvem da instância são ESSDs.

    • appConsistent: Especifica se a consistência de aplicativo deve ser ativada. Este parâmetro deve ser usado em conjunto com os parâmetros preScriptPath e postScriptPath.

    • preScriptPath: O caminho do script de pré-congelamento.

    • postScriptPath: O caminho do script de pós-descongelamento.

    • enableWriters: Este parâmetro é obrigatório apenas quando AppConsistent é definido como true. Especifica se as configurações para snapshots consistentes com o aplicativo devem ser aplicadas. Valor padrão: true.

      • true: cria um snapshot consistente com o aplicativo.

      • false: cria um snapshot consistente com o sistema de arquivos.

    • enableFsFreeze: Este parâmetro é obrigatório apenas quando AppConsistent é definido como true. Especifica se o mecanismo FsFreeze do Linux deve ser usado para garantir a consistência de leitura do sistema de arquivos no modo somente leitura antes de criar um snapshot consistente com o aplicativo. Valor padrão: true.

    • timeoutSeconds: Este parâmetro é obrigatório apenas quando AppConsistent é definido como true. O período de tempo limite de congelamento de E/S. Valor padrão: 30. Unidade: segundos.

    { "doCopy": false, "destinationRegionId": "", "destinationRetention": null, "diskIdList": [], "snapshotGroup": false, "appConsistent": false, "enableWriters": true, "preScriptPath": "", "postScriptPath": "", "enableFsFreeze": true, "timeoutInSeconds": 60 }
    BackupType

    string

    Não

    O tipo de backup. Este parâmetro é obrigatório quando SourceType é definido como UDM_ECS. Valores válidos:

    • COMPLETE: backup completo

    Valores válidos:

    • COMPLETE :

      Backup completo.

    COMPLETE
    VaultId

    string

    Não

    O ID do cofre de backup. Este parâmetro não é obrigatório quando SourceType é definido como UDM_ECS.

    v-000xxxxxxxxxxxxxxy1v
    SpeedLimit

    string

    Não

    A limitação de tráfego de backup. Este parâmetro não entra em vigor quando SourceType é definido como UDM_ECS. O formato é {start}|{end}|{bandwidth}. Separe várias configurações de limite de largura de banda com barras verticais (|). Os períodos de tempo de diferentes configurações não podem se sobrepor.

    • start: A hora de início.

    • end: A hora de término.

    • bandwidth: O limite de largura de banda. Unidade: KB/s.

    0|24|1024
    Options

    string

    Não

    Este parâmetro não é obrigatório.

    {}
    Include

    string

    Não

    Os caminhos para backup. Todos os arquivos nos caminhos especificados são submetidos a backup. Este parâmetro não entra em vigor quando SourceType é definido como UDM_ECS. O valor pode ter até 255 caracteres.

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

    string

    Não

    Os caminhos a serem excluídos do backup. Todos os arquivos nos caminhos especificados não são submetidos a backup. Este parâmetro não entra em vigor quando SourceType é definido como UDM_ECS. O valor pode ter até 255 caracteres.

    ["/var", "/proc"]
    ClusterId

    string

    Não

    Este parâmetro não é obrigatório.

    ""
    ContainerResources

    string

    Não

    Este parâmetro não é obrigatório.

    ""
    InitiatedByAck

    boolean

    Não

    Defina este parâmetro como false ou deixe-o vazio.

    false
    ContainerClusterId

    string

    Não

    Este parâmetro não é obrigatório.

    ""
    CrossAccountType

    string

    Não

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

    • SELF_ACCOUNT: backup da conta atual

    • CROSS_ACCOUNT: backup entre contas

    SELF_ACCOUNT
    CrossAccountUserId

    integer

    Não

    O ID da conta de origem para o backup entre contas gerenciado pela conta atual.

    158975xxxxxx4625
    CrossAccountRoleName

    string

    Não

    O nome da função RAM criada na conta de origem para o backup entre contas gerenciado pela conta atual.

    BackupRole

    Elementos de resposta

    Elemento

    Tipo

    Descrição

    Exemplo

    object

    Code

    string

    O código de retorno. Um valor 200 indica sucesso.

    200
    Message

    string

    A mensagem de retorno. Um valor successful indica sucesso. Se ocorrer um erro, a mensagem de erro correspondente será retornada.

    successful
    RequestId

    string

    O ID da solicitação.

    25F49E7B-7E39-542E-83AD-62E6E7F73786
    Success

    boolean

    Indica se a solicitação foi bem-sucedida. Valores válidos:

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

    • false: A solicitação falhou.

    true
    JobId

    string

    O ID do trabalho de backup.

    job-000csy09q50a2jdcbwbo

    Exemplos

    Resposta de sucesso

    JSON formato

    {
  "Code": "200",
  "Message": "successful",
  "RequestId": "25F49E7B-7E39-542E-83AD-62E6E7F73786",
  "Success": true,
  "JobId": "job-000csy09q50a2jdcbwbo"
}

    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.