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

Descrição da operação

O status da instância deve estar em execução quando você invocar a operação CreateBackup.

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

create

*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.	d-bp2235****
BackupMethod	string	Não	O método de backup da instância. Valores válidos: Snapshot: backup de snapshot Logical: backup lógico Physical: backup físico (padrão) Nota Instâncias com disco em nuvem suportam apenas backup de snapshot. Apenas instâncias de conjunto de réplicas e cluster fragmentado suportam a seleção do método de backup. Você não precisa especificar este parâmetro para instâncias autônomas. O método de backup é fixado como backup de snapshot.	Logical
BackupRetentionPeriod	integer	Não	O período de retenção do backup. Este parâmetro é aplicável apenas a instâncias de conjunto de réplicas e cluster fragmentado com discos em nuvem. Nota Se você não especificar este parâmetro, a política de backup padrão será aplicada. Valores válidos: 7 a 730: 7 a 730 dias -1: retenção de longo prazo	30

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Os dados da resposta.
BackupId	string	O ID do backup. Nota [Descontinuado] Este parâmetro será descontinuado em breve. Para obter o ID do backup, chame a operação DescribeBackups.	5664****
RequestId	string	O ID da solicitação.	7016B12F-7F64-40A4-BAFF-013F02AC82FC
BackupJobId	string	O ID do job de backup.	775051

Exemplos

Resposta de sucesso

JSON formato

{
  "BackupId": "5664****",
  "RequestId": "7016B12F-7F64-40A4-BAFF-013F02AC82FC",
  "BackupJobId": "775051"
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	InvalidBackupMethod.ValueNotSupport	The specified parameter BackupMethod is not valid.
403	OperationDenied.BackupJobExists	The operation is not permitted due to backup job exist.	Uma tarefa de backup está em andamento. Tente novamente mais tarde.
403	OperationDenied.NoDatabase	The operation is not permitted due to no database.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.