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

Consulta os bancos de dados em um horário especificado ou os bancos de dados em um conjunto de backups especificado antes de restaurar um banco de dados para uma instância do ApsaraDB for MongoDB.

Descrição da operação

Você pode chamar a operação CreateDBInstance para restaurar um banco de dados para uma instância do ApsaraDB for MongoDB. Para mais informações, consulte Restaurar um banco de dados de uma instância do ApsaraDB for MongoDB.

Antes de chamar esta operação, certifique-se de que a instância atenda aos seguintes requisitos:

A instância foi criada após 26 de março de 2019.
A instância está localizada nas regiões da China (Qingdao), China (Pequim), China (Zhangjiakou), China (Hohhot), China (Hangzhou), China (Xangai), China (Shenzhen) ou Singapura. Outras regiões não são suportadas.
A instância é uma instância de conjunto de réplicas.
A instância executa o MongoDB 3.4, MongoDB 4.0 ou MongoDB 4.2. Além disso, a instância usa discos locais para armazenar dados.
O mecanismo de armazenamento da instância é o WiredTiger.

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

get

*Instance

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

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
PageNumber	integer	Não	O número da página a ser retornada. O valor deve ser um número inteiro maior que 0. Valor padrão: 1.	1
PageSize	integer	Não	O número de entradas a serem retornadas por página. Valor padrão: 30. Valores válidos: 30, 50 e 100.	30
SourceDBInstance	string	Sim	O ID da instância de origem.	dds-bp2286****
RestoreTime	string	Não	O ponto no tempo para o qual a instância será restaurada. Especifique o horário no padrão ISO 8601 no formato yyyy-MM-ddTHH:mm:ssZ. O horário deve estar em UTC. Nota O horário pode ser um ponto no tempo nos últimos sete dias. O horário deve ser anterior ao horário atual, mas posterior ao horário de criação da instância. Você deve especificar um dos parâmetros RestoreTime ou BackupId.	2019-08-22T12:00:00Z
BackupId	string	Não	O ID do backup. Nota Você pode chamar a operação DescribeBackups para consultar o ID do backup. Você deve especificar um dos parâmetros RestoreTime ou BackupId.	5664****
ResourceGroupId	string	Não	O ID do grupo de recursos.	rg-ax68****
SourceDBInstance	string	Sim	O ID da instância de origem.	dds-bp2286****

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
TotalCount	integer	O número de bancos de dados retornados.	5
Databases	object
Database	array<object>	Os detalhes dos bancos de dados.
	object
DBName	string	The name of the database.	mongodbtest
RequestId	string	O ID da solicitação.	1AF0AD89-ED4F-44AD-B65F-BFC1D5CD9455
PageSize	integer	O número de entradas retornadas por página.	30
PageNumber	integer	O número da página retornada.	1

Exemplos

Resposta de sucesso

JSON formato

{
  "TotalCount": 5,
  "Databases": {
    "Database": [
      {
        "DBName": "mongodbtest"
      }
    ]
  },
  "RequestId": "1AF0AD89-ED4F-44AD-B65F-BFC1D5CD9455",
  "PageSize": 30,
  "PageNumber": 1
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	InvalidMeta.WrongFormat	Meta information is wrong formatter.
400	InvalidRestoreTime.Format	Specified restore time is not valid.	The specified RestoreTime value is invalid.
403	InvalidDBName	The specified database name is not allowed.	The specified database name is invalid.
403	InvalidMeta.TooLarge	Meta information is too large.	The metadata is too large.
403	SingleDBRestore.BackupSetNotSupport	This backup set do not support this operation.	Single-database recovery is not supported for the specified time point or backup file.
403	IncorrectDBInstanceType	Current DB instance type does not support this operation.
403	IncorrectEngineVersion	Current engine version does not support operations.
403	InvalidBackupLogStatus	Current backup log enable status does not support this operation.	The operation is not supported when log backup is enabled.
403	IncorrectBackupSetState	Current backup set state does not support operations..
404	InvalidBackupSetID.NotFound	Specifiedbackup set ID does not exist.
404	InvalidBackup.NotFound	Theavailable backup does not exist in recovery time.	No backup set is available during the specified recovery period.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.