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

Consulta a lista de backups de uma instância do ApsaraDB for 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:DescribeBackups

get

*Instância.

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. Nota Se você definir este parâmetro como o ID de uma instância de cluster sharded, também deverá especificar o parâmetro NodeId.	dds-bp1a7009eb24****
NodeId	string	Não	O ID da instância do nó shard na instância de cluster sharded. Nota Este parâmetro é obrigatório se você definir o parâmetro DBInstanceId como o ID da instância de um cluster sharded.	d-bp128a003436****
BackupId	string	Não	O ID da instância. Se você definir o parâmetro DBInstanceId como o ID de uma instância de cluster sharded, o número de IDs de instância será igual ao número de nós shard. Separe vários IDs de instância com vírgulas (,).	2072**,2072,2072**
PageNumber	integer	Não	O número da página. O valor deve ser um número inteiro positivo que não exceda o valor máximo do tipo de dados Integer. Valor padrão: 1.	1
PageSize	integer	Não	O número de entradas por página. Valores válidos: 30 (padrão) 50 100 Valores válidos: 30 : 30 entradas por página. 50 : 50 entradas por página. 100 : 100 entradas por página.	30
StartTime	string	Não	O início do intervalo de tempo a ser consultado. Especifique a hora no formato aaaa-MM-ddTHH:mmZ (UTC). Nota Este parâmetro é inválido se BackupId for especificado.	2022-01-13T13:00Z
EndTime	string	Não	O fim do intervalo de tempo a ser consultado. A hora de término deve ser posterior à hora de início. Especifique a hora no formato aaaa-MM-ddTHH:mmZ (UTC). Nota Este parâmetro é inválido se BackupId for especificado.	2022-01-14T13:00Z
SrcRegion	string	Não	A região onde a instância reside. Nota Este parâmetro é obrigatório para restaurar uma instância excluída. Este parâmetro é obrigatório para backups com georredudância.	cn-beijing
DestRegion	string	Não	A região onde o backup reside. Nota Este parâmetro é obrigatório para backups com georredudância.	cn-hangzhou
ResourceGroupId	string	Não	O ID do grupo de recursos.	rg-xxxx
BackupJobId	string	Não	O ID da tarefa de backup.	775051

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	As informações de backup da instância.
TotalCount	integer	O número total de backups.	1
RequestId	string	O ID da solicitação.	275D43C3-F12F-5224-B375-************
PageSize	integer	O número de entradas por página. Valores válidos: 30 (padrão) 50 100	30
PageNumber	integer	O número da página.	1
Backups	object
Backup	array<object>	A lista de detalhes dos arquivos de backup.
	object	A lista de detalhes dos arquivos de backup.
BackupStatus	string	O status do backup. Valores válidos: Success: O backup foi bem-sucedido. Failed: O backup falhou.	Success
BackupType	string	O tipo de backup. Valores válidos: FullBackup: backup completo. IncrementalBackup: backup incremental.	FullBackup
BackupStartTime	string	A hora de início do backup. A hora está no formato aaaa-MM-ddTHH:mm:ssZ (UTC).	2022-01-14T03:56:17Z
BackupIntranetDownloadURL	string	A URL de download interno do arquivo de backup. Nota Você pode usar esta URL para baixar o arquivo de backup de uma instância ECS que esteja na mesma rede da instância do ApsaraDB for MongoDB.	http://rdsbak-hz-v3.oss-cn-hangzhou-internal.aliyuncs.com/custins5559***/hins1936_data_2022052504_qp.xb?Expires=165361&OSSAccessKeyId=*******************&Signature=****************************&Region=cn-hangzhou
BackupSize	integer	O tamanho do arquivo de backup. Unidade: bytes.	6168576
BackupDownloadURL	string	A URL de download público do arquivo de backup. Uma string vazia é retornada se o arquivo de backup estiver indisponível para download no momento.	http://rdsbak-hz-v3.oss-cn-hangzhou.aliyuncs.com/custins5559**/hins1936_data_2022052504_qp.xb?Expires=165361&OSSAccessKeyId=********************&Signature=****************************&Region=cn-hangzhou
BackupMode	string	O modo de backup. Valores válidos: Automated: backup automático. Manual: backup manual.	Automated
BackupEndTime	string	A hora de término do backup. A hora está no formato aaaa-MM-ddTHH:mm:ssZ (UTC).	2022-01-14T03:57:34Z
BackupId	string	O ID do backup.	32102****
BackupDBNames	string	O nome do banco de dados incluído no backup.	database
BackupMethod	string	O método de backup. Valores válidos: Snapshot: backup de snapshot. Physical: backup físico. Logical: backup lógico.	Physical
BackupJobId	string	O ID da tarefa de backup.	1123xxxx
BackupName	string	O nome do conjunto de backup. Este parâmetro é atualmente inválido.	12345678.tar.gz
BackupScale	string	A granularidade do backup. Este parâmetro é atualmente inválido.	DBInstance
IsAvail	boolean	Indica se o conjunto de backup está disponível. Valores válidos: 0: indisponível. 1: disponível.	1
EngineVersion	string	A versão do mecanismo de banco de dados da instância quando o backup foi criado. Valores válidos: 7.0 6.0 5.0 4.4 4.2 4.0 3.4	4.2
BackupExpireTime	string	A hora em que o backup expira. A hora está no formato aaaa-MM-ddTHH:mm:ssZ (UTC). Importante "9999-01-01T00:00:00Z" indica retenção de longo prazo (LTR).	2025-08-30T09:49:11Z

Exemplos

Resposta de sucesso

JSON formato

{
  "TotalCount": 1,
  "RequestId": "275D43C3-F12F-5224-B375-************",
  "PageSize": 30,
  "PageNumber": 1,
  "Backups": {
    "Backup": [
      {
        "BackupStatus": "Success",
        "BackupType": "FullBackup",
        "BackupStartTime": "2022-01-14T03:56:17Z",
        "BackupIntranetDownloadURL": "http://rdsbak-hz-v3.oss-cn-hangzhou-internal.aliyuncs.com/custins5559*****/hins1936****_data_2022052504****_qp.xb?Expires=165361****&OSSAccessKeyId=***********************&Signature=******************************&Region=cn-hangzhou",
        "BackupSize": 6168576,
        "BackupDownloadURL": "http://rdsbak-hz-v3.oss-cn-hangzhou.aliyuncs.com/custins5559****/hins1936****_data_2022052504****_qp.xb?Expires=165361****&OSSAccessKeyId=************************&Signature=******************************&Region=cn-hangzhou",
        "BackupMode": "Automated",
        "BackupEndTime": "2022-01-14T03:57:34Z",
        "BackupId": "32102****",
        "BackupDBNames": "database",
        "BackupMethod": "Physical",
        "BackupJobId": "1123xxxx",
        "BackupName": "12345678.tar.gz",
        "BackupScale": "DBInstance",
        "IsAvail": true,
        "EngineVersion": "4.2",
        "BackupExpireTime": "2025-08-30T09:49:11Z"
      }
    ]
  }
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro
400	InvalidStartTime.Malformed	The Specified parameter StartTime is not valid.
400	InvalidEndTime.Malformed	The Specified parameter EndTime is not valid.
400	InvalidStartTimeAndEndTime.Malformed	The Specified parameter StartTime or EndTime is not valid.
400	InvalidPageSize.Malformed	The specified parameter PageSize 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.