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

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

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

get

*dbinstance

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****
InstanceType	string	Não	O tipo de instância. Valores válidos: replicate: instância de conjunto de réplicas sharding: instância de cluster fragmentado	sharding
SrcRegion	string	Não	A região onde a instância está implantada.	cn-beijing

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Os dados da resposta.
BackupInterval	integer	A frequência de backup de alta frequência. Valores válidos: -1: o backup de alta frequência está desativado 15: a cada 15 minutos 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	-1
BackupRetentionPeriod	string	O período de retenção de backup em dias.	30
BackupRetentionPolicyOnClusterDeletion	integer	A política de retenção de dados 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: Um backup automático é criado quando a instância é liberada, e o conjunto de backup é retido para retenção de longo prazo (LTR). 2: Um backup automático é criado 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 Backup de retenção de longo prazo.	0
CrossBackupPeriod	string	Os dias da semana em que os backups com redundância geográfica são realizados. 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 Obrigatório para backups com redundância geográfica.	Monday
CrossLogRetentionType	string	O tipo de retenção para backups de log entre regiões. Valores válidos: delay: retido por um período especificado never: nunca expira	delay
CrossLogRetentionValue	integer	O período de retenção para backups de log entre regiões.	7
CrossRetentionType	string	O tipo de retenção para backups com redundância geográfica. Valores válidos: delay: retido por um período especificado never: nunca expira	delay
CrossRetentionValue	integer	O período de retenção para backups com redundância geográfica.	7
DestRegion	string	A região onde os backups com redundância geográfica são armazenados.	cn-shenzhen
EnableBackupLog	integer	Especifica se o backup de log deve ser ativado. Valores válidos: 0: desativado (padrão) 1: ativado	1
EnableCrossLogBackup	integer	Especifica se o backup de log entre regiões está ativado. Nota Obrigatório para backups com redundância geográfica. 1: ativado (deve ser definido como 1 para instâncias de cluster fragmentado) 0: desativado (deve ser definido como 0 para instâncias de conjunto de réplicas)	1
HighFrequencyBackupRetention	string	O período de retenção para backups de alta frequência, em dias.	1
LogBackupRetentionPeriod	integer	O período de retenção para backups de log, em dias. Valores válidos: 7 a 730.	7
PreferredBackupPeriod	string	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	Monday,Tuesday,Wednesday,Thursday,Friday,Saturday,Sunday
PreferredBackupTime	string	O horário de backup. O formato é HH:mmZ-HH:mmZ (horário UTC).	09:00Z-10:00Z
PreferredNextBackupTime	string	O horário do próximo backup regular. O formato é yyyy-mm-ddthh:mmz (horário UTC).	2024-06-19T19:11Z
PreserveOneEachHour	boolean	Especifica se o backup esparso dentro de uma hora deve ser ativado. Valores válidos: true: Quando a frequência de backup é definida 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: O backup esparso dentro de uma hora está desativado. Todos os snapshots dentro do período de retenção de backup de alta frequência são retidos.	false
RequestId	string	O ID da solicitação.	5A9464CA-F7DC-5434-90B1-DF7F197C****
SnapshotBackupType	string	O tipo de backup de snapshot. Valores válidos: Flash: backup em segundos Standard: backup padrão (padrão)	Standard
SrcRegion	string	A região onde a instância de origem está implantada.	cn-hangzhou

Exemplos

Resposta de sucesso

JSON formato

{
  "BackupInterval": -1,
  "BackupRetentionPeriod": "30",
  "BackupRetentionPolicyOnClusterDeletion": 0,
  "CrossBackupPeriod": "Monday",
  "CrossLogRetentionType": "delay",
  "CrossLogRetentionValue": 7,
  "CrossRetentionType": "delay",
  "CrossRetentionValue": 7,
  "DestRegion": "cn-shenzhen",
  "EnableBackupLog": 1,
  "EnableCrossLogBackup": 1,
  "HighFrequencyBackupRetention": "1",
  "LogBackupRetentionPeriod": 7,
  "PreferredBackupPeriod": "Monday,Tuesday,Wednesday,Thursday,Friday,Saturday,Sunday",
  "PreferredBackupTime": "09:00Z-10:00Z",
  "PreferredNextBackupTime": "2024-06-19T19:11Z",
  "PreserveOneEachHour": false,
  "RequestId": "5A9464CA-F7DC-5434-90B1-DF7F197C****",
  "SnapshotBackupType": "Standard",
  "SrcRegion": "cn-hangzhou"
}

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.