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

O backup entre regiões é aplicável apenas a instâncias de conjunto de réplicas e cluster fragmentado que utilizam 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 período de tempo durante o qual os backups são realizados. O formato é HH:mmZ-HH:mmZ (UTC). Nota O período de tempo é limitado a 1 hora.	03:00Z-04:00Z
PreferredBackupPeriod	string	Não	O ciclo de backup. Valores válidos: Monday: Segunda-feira. Tuesday: Terça-feira. Wednesday: Quarta-feira. Thursday: Quinta-feira. Friday: Sexta-feira. Saturday: Sábado. Sunday: Domingo. Importante Para garantir a segurança dos dados, faça backup dos seus dados do MongoDB pelo menos duas vezes por semana. Nota Se você especificar vários valores, separe-os por vírgulas (,).	Monday,Wednesday,Friday,Sunday
BackupRetentionPeriod	integer	Não	O número de dias durante os quais os backups completos são retidos. Nota Para usuários que criaram instâncias antes de 10 de setembro de 2021, o período de retenção padrão é de 7 dias. Para novos usuários que criaram instâncias em ou 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 As instâncias de cluster fragmentado não suportam a desativação do backup de log.	0
LogBackupRetentionPeriod	integer	Não	O número de dias durante os quais os backups de log são retidos. 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 segundos. Standard: Backup padrão. Este é o valor padrão.	Standard
BackupInterval	string	Não	A frequência de backup de alta frequência. Valores válidos: -1: Desativa os backups de alta frequência. 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 SnapshotBackupType estiver definido como Standard, este parâmetro deverá ser definido como -1. Se SnapshotBackupType estiver definido como Flash e este parâmetro estiver definido como um valor maior que 0, os backups de alta frequência entrarão em vigor.	-1
HighFrequencyBackupRetention	integer	Não	O número de dias durante os quais os backups de alta frequência são retidos. Antes de usar este parâmetro, certifique-se de que o parâmetro BackupInterval esteja especificado. Valor padrão: 1.	1
BackupRetentionPolicyOnClusterDeletion	integer	Não	A política de retenção de dados de backup. Valores válidos: 0: Exclui todos os conjuntos de backup da instância imediatamente quando a instância é liberada. 1: Um backup automático é realizado quando a instância é liberada, e o conjunto de backup é retido para retenção de longo prazo (LTR). 2: Um backup automático é realizado quando a instância é liberada, e todos os conjuntos de backup do cluster são retidos para retenção de longo prazo (LTR). Para mais informações, consulte Backups de retenção de longo prazo.	2
CrossBackupType	string	Não	A política de operação para backup entre regiões. Valores válidos: update: Modifica a política de backup entre regiões. delete: Exclui a política de backup entre regiões. Nota Este parâmetro é obrigatório para o backup entre regiões.	update
SrcRegion	string	Não	A região onde a instância está implantada. Nota Este parâmetro é obrigatório para recuperar instâncias excluídas. Este parâmetro é obrigatório para o backup entre regiões.	cn-beijing
DestRegion	string	Não	A região onde os backups são armazenados. Nota Este parâmetro é obrigatório para o backup entre regiões.	cn-hangzhou
CrossRetentionType	string	Não	O tipo de retenção para o backup entre regiões. Valores válidos: delay: Retém os backups por um período especificado. never: Nunca expira. Nota Este parâmetro é obrigatório para o backup entre regiões.	delay
CrossRetentionValue	integer	Não	O período de retenção para o backup entre regiões. Valores válidos: 3 a 1825 dias. Nota Este parâmetro é obrigatório para o backup entre regiões. Este parâmetro é obrigatório e deve ser especificado quando CrossRetentionType estiver definido como delay.	7
CrossBackupPeriod	string	Não	Os dias da semana em que o backup entre regiões é realizado. Valores válidos: Monday: Segunda-feira. Tuesday: Terça-feira. Wednesday: Quarta-feira. Thursday: Quinta-feira. Friday: Sexta-feira. Saturday: Sábado. Sunday: Domingo. Nota Este parâmetro é obrigatório para o backup entre regiões. Se você especificar vários valores, separe-os por vírgulas (,). Quando as configurações de backup estiverem definidas como backup padrão, o valor deve ser um subconjunto do período de backup PreferredBackupPeriod.	Monday,Tuesday,Wednesday,Thursday,Friday,Saturday,Sunday
EnableCrossLogBackup	integer	Não	Especifica se o backup de log entre regiões deve ser ativado. Nota Este parâmetro é obrigatório para o backup entre regiões. 1: Ativa o backup de log entre regiões. Este valor é obrigatório para instâncias de cluster fragmentado. Para instâncias de conjunto de réplicas, este valor é obrigatório se você quiser oferecer suporte à recuperação em um ponto no tempo entre regiões. 0: Desativa o backup de log entre regiões.	1
CrossLogRetentionType	string	Não	O tipo de retenção para o backup de log entre regiões. Valores válidos: delay: Retém os backups por um período especificado. never: Nunca expira. Nota Este parâmetro é obrigatório para o backup entre regiões.	delay
CrossLogRetentionValue	integer	Não	O período de retenção para o backup de log entre regiões. Valores válidos: 3 a 1825 dias. O valor deve ser menor ou igual ao valor de CrossRetentionValue. Nota Este parâmetro é obrigatório para o backup entre regiões.	3
InstanceType	string	Não	O tipo de instância. Valores válidos: replicate sharding Nota Este parâmetro é obrigatório quando o tipo de recuperação de backup está definido como reconstrução de uma instância excluída. Este parâmetro é obrigatório quando o tipo de recuperação de backup está definido como clonagem de uma instância a partir de um backup entre regiões.	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 estiver definida em minutos, todos os snapshots tirados dentro de 1 hora a partir do horário atual serã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 tirado após a hora será retido. false: Todos os snapshots tirados dentro do período de retenção de backup de alta frequência são retidos.	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.