Todos os produtos
Search

Este produto

    ApsaraDB for MongoDB:ModifyAdvancedBackupPolicy

    Central de documentação

    ApsaraDB for MongoDB:ModifyAdvancedBackupPolicy

    Última atualização: Oct 12, 2026

    Modifica a política de backup avançada.

    Descrição da operação

    A georredudância aplica-se apenas a instâncias de conjunto de réplicas de disco em nuvem e instâncias fragmentadas de disco em nuvem.

    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

    dds:ModifyAdvancedBackupPolicy

    update

    *Instance

    acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}

    		 Nenhuma Nenhuma

    Parâmetros da solicitação

    Parâmetro

    Tipo

    Obrigatório

    Descrição

    Exemplo
    DBInstanceId

    string

    Sim

    O ID da instância.

    dds-2zeb2d64cb46xxxx
    PreferredBackupTime

    string

    Não

    O período de tempo durante o qual o backup é realizado. O formato é HH:mmZ-HH:mmZ (UTC).

    Nota

    O intervalo de tempo é limitado a 1 hora.

    09:00Z-10:00Z
    SnapshotBackupType

    string

    Não

    O tipo de backup de snapshot. Valores válidos:

    • Flash: backup em segundos.

    • Standard: backup padrão. Este é o valor padrão.

    Valores válidos:

    • Standard :

      Backup padrão. Este é o valor padrão.

    • Flash :

      Backup em segundos.

    Standard
    BackupRetentionPolicyOnClusterDeletion

    integer

    Sim

    A política de retenção de backup. Valores válidos:

    • 0: Todos os conjuntos de backup da instância são excluídos imediatamente quando a instância é liberada.

    • 1: O último conjunto de backup é retido para retenção de longo prazo (LTR) quando a instância é liberada.

    • 2: Todos os conjuntos de backup são retidos para retenção de longo prazo (LTR) quando a instância é liberada.

    Valores válidos:

    • 0 :

      Todos os conjuntos de backup são excluídos imediatamente.

    • 1 :

      O último conjunto de backup é retido para retenção de longo prazo (LTR).

    • 2 :

      Todos os conjuntos de backup são retidos para retenção de longo prazo (LTR).

    0
    AdvancedBackupDataPolicies

    array<object>

    Não

    A lista de políticas de backup.

    object

    Não

    PolicyId

    string

    Não

    O ID da política de backup.

    Importante Obrigatório quando ActionType não for CREATE.

    xxxxxx
    ActionType

    string

    Sim

    A ação. Valores válidos:

    • CREATE: Cria uma política.

    • UPDATE: Atualiza uma política.

    • DELETE: Exclui uma política. Se este valor for especificado, apenas o parâmetro PolicyId é obrigatório.

    Valores válidos:

    • DELETE :

      Exclui uma política.

    • CREATE :

      Cria uma política.

    • UPDATE :

      Atualiza uma política.

    CREATE
    RetentionType

    string

    Não

    O tipo de ciclo de retenção do conjunto de backup. Valores válidos:

    • never: retenção de longo prazo (LTR).

    • delay: retenção por um número fixo de dias.

    Importante Obrigatório quando ActionType não for DELETE.

    Valores válidos:

    • never :

      Retenção de longo prazo (LTR).

    • delay :

      Retenção por um número fixo de dias.

    delay
    RetentionPeriod

    integer

    Não

    O período de retenção do plano de backup em dias. Valores válidos:

    • Backup na mesma região: 7 a 7300 dias.

    • Georredudância: 3 a 1825 dias.

    Importante Obrigatório quando RetentionType estiver definido como delay.

    7
    BackupPolicy

    string

    Não

    O tipo de agendamento da política avançada. Valores válidos:

    • dayOfWeek: agendado por semana.

    • dayOfMonth: agendado por mês.

    • dayOfYear: agendado por ano.

    • backupInterval: agendado em um intervalo fixo (backup de alta frequência).

    Nota

    • Não há suporte para várias políticas de backup de alta frequência.

    • Não há suporte para vários backups de georredudância, e as políticas de georredudância suportam apenas dayOfWeek.

    Importante Obrigatório quando ActionType não for DELETE.

    Valores válidos:

    • dayOfWeek :

      Agendado por semana.

    • dayOfMonth :

      Agendado por mês.

    • dayOfYear :

      Agendado por ano.

    • backupInterval :

      Agendado em um intervalo fixo (backup de alta frequência).

    dayOfWeek
    PreferredBackupPeriod

    string

    Não

    O ciclo de backup. Valores válidos:

    • Quando BackupPolicy estiver definido como dayOfWeek: 1, 2, 3, 4, 5, 6 e 7 representam de segunda a domingo. Pelo menos dois backups devem ser realizados por semana.

    • Quando BackupPolicy estiver definido como dayOfMonth: 1, 3 e -1 representam o 1º, 3º e o último dia de cada mês. -1 representa o último dia do mês.

    • Quando BackupPolicy estiver definido como dayOfYear: 01-07 representa 7 de janeiro. Apenas um dia pode ser selecionado.

    • Quando BackupPolicy estiver definido como backupInterval: especifique um dos seguintes números em minutos. Para clusters fragmentados, os valores válidos são 30, 60, 120, 180, 240, 360, 480 e 720. Para conjuntos de réplicas, os valores válidos são 15, 30, 60, 120, 180, 240, 360, 480 e 720.

    Nota:

    Importante Obrigatório quando ActionType não for DELETE. As políticas de georredudância suportam apenas dayOfWeek.

    1,4,6
    SrcRegion

    string

    Não

    A região onde a instância reside.

    Importante Obrigatório quando ActionType não for DELETE.

    cn-guangzhou
    SrcType

    string

    Não

    O tipo de origem da política de backup. Valores válidos:

    • db: backup na mesma região.

    • level1: backup entre regiões.

    Importante Obrigatório quando ActionType não for DELETE.

    Valores válidos:

    • level1 :

      Backup entre regiões.

    • db :

      Backup na mesma região.

    db
    DestRegion

    string

    Não

    A região de destino da política de backup.

    Importante Obrigatório quando ActionType não for DELETE.

    cn-guangzhou
    DestType

    string

    Não

    O tipo de destino da política de backup. Valores válidos:

    • level1: backup na mesma região.

    • level2Cross: backup entre regiões.

    Importante Obrigatório quando ActionType não for DELETE.

    Valores válidos:

    • level1 :

      Backup na mesma região.

    • level2Cross :

      Backup entre regiões.

    level1
    PreserveOneEachHour

    boolean

    Não

    Especifica se o backup esparso por hora deve ser ativado. Valores válidos:

    • true: Quando a frequência de backup for em minutos, todos os snapshots tirados dentro de 1 hora a partir do horário atual são retidos. Para snapshots tirados há mais de 1 hora, mas dentro de 24 horas a partir do horário atual, apenas o primeiro snapshot após a hora é retido.

    • false: Todos os snapshots dentro do período de retenção de backups de alta frequência são retidos.

    False
    AdvancedBackupLogPolicies

    array<object>

    Não

    A lista de políticas de backup de logs.

    object

    Não

    EnableLogBackup

    integer

    Sim

    Especifica se o backup de logs deve ser ativado. Valores válidos:

    • 1: ativado.

    • 0: desativado.

    Nota

    • O backup de logs deve ser ativado para instâncias fragmentadas.

    • Você deve ativar o backup de logs na mesma região antes de poder ativar o backup de logs entre regiões.

    Valores válidos:

    • 0 :

      Desativado.

    • 1 :

      Ativado.

    1
    RetentionType

    string

    Não

    O tipo de ciclo de retenção do backup de logs. Valores válidos:

    • never: retenção de longo prazo (LTR).

    • delay: retenção por um número fixo de dias.

    Valores válidos:

    • never :

      Retenção de longo prazo (LTR).

    • delay :

      Retenção por um número fixo de dias.

    delay
    RetentionPeriod

    integer

    Não

    O período de retenção do backup de logs em dias. Este parâmetro entra em vigor quando RetentionType estiver definido como delay. Valores válidos:

    • Backup na mesma região: 7 a 7300 dias.

    • Georredudância: 3 a 1825 dias. O valor deve ser menor que o período de retenção de backup da política de georredudância.

    7
    SrcRegion

    string

    Não

    A região onde a instância de origem reside.

    cn-hangzhou
    SrcType

    string

    Não

    O tipo de origem da política de backup de logs. Valores válidos:

    • db: backup na mesma região.

    • level1: backup entre regiões.

    Valores válidos:

    • level1 :

      Backup entre regiões.

    • db :

      Backup na mesma região.

    db
    DestRegion

    string

    Não

    A região onde o backup de logs de georredudância é armazenado.

    Nota

    Obrigatório para georredudância.

    cn-huhehaote
    DestType

    string

    Não

    O tipo de destino da política de backup de logs. Valores válidos:

    • level1: backup na mesma região.

    • level2Cross: backup entre regiões.

    Valores válidos:

    • level1 :

      Backup na mesma região.

    • level2Cross :

      Backup entre regiões.

    level1
    PolicyId

    string

    Não

    O ID da política de backup de logs. Este parâmetro é obrigatório apenas para políticas de backup de logs entre regiões.

    xxxx
    ActionType

    string

    Sim

    O tipo de operação. Valores válidos:

    • CREATE: Cria uma política.

    • UPDATE: Atualiza uma política.

    Importante Este parâmetro entra em vigor apenas para georredudância. Para excluir a georredudância, defina EnableLogBackup como 0 e ActionType como UPDATE.

    Valores válidos:

    • CREATE :

      Cria uma política.

    • UPDATE :

      Atualiza uma política.

    CREATE

    Elementos de resposta

    Elemento

    Tipo

    Descrição

    Exemplo

    object

    RequestId

    string

    O ID da solicitação.

    2F42BB4E-461F-5B55-A37C-53B1141C****

    Exemplos

    Resposta de sucesso

    JSON formato

    {
  "RequestId": "2F42BB4E-461F-5B55-A37C-53B1141C****"
}

    Códigos de erro

    Código de status HTTP

    Código de erro

    Mensagem de erro

    Descrição
    400 InvalidPreferredBackupPeriod.Malformed Specified parameter PreferredBackupPeriod is not valid.
    400 InvalidPreferredBackupTime.Malformed Specified parameter PreferredBackupTime is not valid.

    Consulte Códigos de Erro para uma lista completa.

    Notas de versão

    Consulte Notas de Versão para uma lista completa.