ModifyBackupPolicy - ApsaraDB for MongoDB: Central de Documentação do Alibaba Cloud

Modifica a política de backup de uma instância do MongoDB.

Descrição da operação

A georredudância está disponível apenas para instâncias de conjunto de réplicas e instâncias de cluster fragmentado que usam discos 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:ModifyBackupPolicy

update

*Instance

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

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
DBInstanceId	string	Sim	O ID da instância.	dds-bp16cb162771****
PreferredBackupTime	string	Não	O intervalo de tempo para realizar um backup. Especifique o horário no formato HH:mmZ-HH:mmZ. O horário é exibido no Tempo Universal Coordenado (UTC). Nota O intervalo de tempo deve ser de 1 hora.	03:00Z-04:00Z
PreferredBackupPeriod	string	Não	O ciclo de backup. Valores válidos: Monday Tuesday Wednesday Thursday Friday Saturday Sunday Importante Para garantir a segurança dos dados, faça backup da instância do MongoDB pelo menos duas vezes por semana. Nota Para especificar vários ciclos de backup, separe-os com vírgulas (,).	Monday,Wednesday,Friday,Sunday
BackupRetentionPeriod	integer	Não	O número de dias para reter backups completos. Nota Para instâncias criadas antes de 10 de setembro de 2021, o período de retenção padrão é de 7 dias. Para instâncias criadas após 10 de setembro de 2021, o período de retenção padrão é de 30 dias.	30
EnableBackupLog	integer	Não	Especifica se o backup de log deve ser ativado. Valores válidos: 0: Desativa o backup de log. Este é o valor padrão. 1: Ativa o backup de log. Importante Você não pode desativar o backup de log para instâncias de cluster fragmentado.	0
LogBackupRetentionPeriod	integer	Não	O número de dias para reter backups de log. Valor padrão: 7. Valores válidos: 7 a 730.	7
SnapshotBackupType	string	Não	O tipo de backup de snapshot. Valores válidos: Flash: backup em nível de segundo. Standard: backup convencional. Este é o valor padrão.	Standard
BackupInterval	string	Não	A frequência de backups de alta frequência. Valores válidos: -1: O backup de alta frequência está desativado. 30: a cada 30 minutos. 60: a cada 1 hora. 120: a cada 2 horas. 180: a cada 3 horas. 240: a cada 4 horas. 360: a cada 6 horas. 480: a cada 8 horas. 720: a cada 12 horas. Nota Se você definir SnapshotBackupType como Standard, o valor deste parâmetro será -1. O backup de alta frequência só entra em vigor se você definir SnapshotBackupType como Flash e definir este parâmetro com um valor maior que 0.	-1
HighFrequencyBackupRetention	integer	Não	O número de dias para reter backups de alta frequência. Antes de especificar este parâmetro, você deve definir o parâmetro BackupInterval. O período de retenção padrão é de 1 dia.	1
BackupRetentionPolicyOnClusterDeletion	integer	Não	A política para reter backups quando você libera a instância. 0: Todos os conjuntos de backup da instância são excluídos quando a instância é liberada. 1: Um backup automático é realizado quando a instância é liberada, e este backup é retido por um longo período. 2: Um backup automático é realizado quando a instância é liberada, e todos os conjuntos de backup da instância são retidos por um longo período. Para mais informações, consulte Retenção de backup de longo prazo.	2
CrossBackupType	string	Não	A política para backups georredudantes. Valores válidos: update: Modifica a política de georredudância. delete: Exclui a política de georredudância. Nota Este parâmetro é obrigatório se você ativar a georredudância.	update
SrcRegion	string	Não	O ID da região da instância. Nota Este parâmetro é obrigatório se você restaurar uma instância excluída. Este parâmetro é obrigatório se você ativar a georredudância.	cn-beijing
DestRegion	string	Não	O ID da região do backup georredudante. Nota Este parâmetro é obrigatório se você ativar a georredudância.	cn-hangzhou
CrossRetentionType	string	Não	A política de retenção para backups georredudantes. Valores válidos: delay: Retém o backup por um período especificado. never: Retém o backup permanentemente. Nota Este parâmetro é obrigatório se você ativar a georredudância.	delay
CrossRetentionValue	integer	Não	O número de dias para reter backups georredudantes. Valores válidos: 3 a 1825. Nota Este parâmetro é obrigatório se você ativar a georredudância. Este parâmetro é obrigatório se você definir CrossRetentionType como delay.	7
CrossBackupPeriod	string	Não	Os dias da semana para realizar backups georredudantes. Valores válidos: Monday Tuesday Wednesday Thursday Friday Saturday Sunday Nota Este parâmetro é obrigatório se você ativar a georredudância. Para especificar vários dias, separe-os com vírgulas (,). Se você definir o método de backup como backup convencional, os dias da semana especificados por este parâmetro devem ser um subconjunto dos dias da semana especificados por PreferredBackupPeriod.	Monday,Tuesday,Wednesday,Thursday,Friday,Saturday,Sunday
EnableCrossLogBackup	integer	Não	Especifica se o backup de log entre regiões deve ser ativado. Valores válidos: Nota Este parâmetro é obrigatório se você ativar a georredudância. 1: Ativa o backup de log entre regiões. Este valor é obrigatório para instâncias de cluster fragmentado. Este valor também é obrigatório para instâncias de conjunto de réplicas se você quiser ativar a recuperação de ponto no tempo georredudante. 0: Desativa o backup de log entre regiões.	1
CrossLogRetentionType	string	Não	A política de retenção para backups de log entre regiões. Valores válidos: delay: Retém o backup por um período especificado. never: Retém o backup permanentemente. Nota Este parâmetro é obrigatório se você ativar a georredudância.	delay
CrossLogRetentionValue	integer	Não	O número de dias para reter backups de log entre regiões. Valores válidos: 3 a 1825. O valor deve ser menor ou igual ao valor de CrossRetentionValue. Nota Este parâmetro é obrigatório se você ativar a georredudância.	3
InstanceType	string	Não	O tipo de instância. Valores válidos: replicate sharding Nota Este parâmetro é obrigatório quando você restaura uma instância excluída. Este parâmetro é obrigatório quando você clona uma instância a partir de um backup georredudante.	replicate
PreserveOneEachHour	boolean	Não	Especifica se o backup esparso por hora deve ser ativado. Valores válidos: true: Se a frequência de backup for em minutos, todos os snapshots gerados na última hora serão retidos. Para snapshots gerados há mais de 1 hora, mas menos de 24 horas, apenas o primeiro snapshot gerado após cada hora cheia é retido. false: Todos os snapshots são retidos dentro do período de retenção de backup de alta frequência.	true

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
RequestId	string	O ID da solicitação.	644A359C-B871-4DD3-97B5-ED91EF5809C2

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "644A359C-B871-4DD3-97B5-ED91EF5809C2"
}

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.