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

Consulta os arquivos de backup de log 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

Nenhuma autorização necessária para esta operação. Se você encontrar problemas com esta operação, entre em contato com o suporte técnico.

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
RegionId	string	Não	O ID da região.	cn-zhangjiakou
DBInstanceId	string	Sim	O ID da instância. Se a instância for um cluster fragmentado, você também deve especificar o parâmetro NodeId.	dds-wz9ca592fc637a54
NodeId	string	Não	O ID do nó mongos ou do nó shard na instância de cluster fragmentado. Nota Este parâmetro é aplicável apenas a instâncias de cluster fragmentado.	d-uf696817a1b5d9f4
StartTime	string	Sim	A hora de início da consulta. A hora está no formato aaaa-MM-ddTHH:mm:ss.xxxZ. A hora é exibida em UTC.	2021-03-23T06:24:21.425Z
EndTime	string	Sim	A hora de término da consulta. A hora deve ser posterior à hora de início. A hora está no formato aaaa-MM-ddTHH:mm:ss.xxxZ. A hora é exibida em UTC.	2023-04-17T05:50:28.914Z
PageSize	integer	Não	O número de entradas a serem retornadas em cada página.	10
PageNumber	integer	Não	O número da página.	1
SrcRegion	string	Não	A região da instância de origem para um backup entre regiões. Nota Este parâmetro é obrigatório ao consultar backups entre regiões.	ap-southeast-1
DestRegion	string	Não	A região onde o backup entre regiões é armazenado. Nota Este parâmetro é obrigatório ao consultar backups entre regiões.	cn-beijing
BinlogId	string	Não	O ID do binlog. Este parâmetro não é suportado atualmente.	null
ResourceGroupId	string	Não	O ID do grupo de recursos.	rg-xxxx

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
RequestId	string	O ID da solicitação.	F8CA8312-530A-413A-9129-F2BB32A8D404
PageNumber	integer	O número da página dos resultados retornados.	3
MaxRecordsPerPage	integer	O número de entradas a serem retornadas em cada página.	30
TotalRecordCount	integer	O número total de arquivos binlog encontrados.	240
Items	object
LogFile	array<object>	Os detalhes dos arquivos binlog.
	object	Os detalhes de um arquivo binlog.
LogFileName	string	The name of the binlog file.	1709846151
DumpDownloadURL	string	The OSS download link for the binlog file. (Currently not supported.)	null
LogBeginTime	string	The start time of the data in the binlog file. Format: yyyy-MM-ddTHH:mm:ssZ (UTC)	2024-03-08T09:31:29Z
DumpBucket	string	The storage location of the binlog file. (Currently not supported.)	null
LinkExpiredTime	string	The URL expiration time. (Currently not supported.)	null
DownloadLink	string	The download link for the binlog file.	https://rdslog-shanghai.xxxxxxxxx
OSSEndpoint	string	The OSS endpoint where the binlog file is stored. (Currently not supported.)	null
LogEndTime	string	The end time of the data in the binlog file. Format: yyyy-MM-ddTHH:mm:ssZ (UTC).	2024-03-09T02:55:00Z
DumpState	integer	The dump status. (Currently not supported.)	null
FileSize	string	The size of the binlog file, in bytes.	603127135
FileId	string	The unique identifier for the binlog file.	5098
BinLogId	string	The binlog ID. (Currently not supported.)	null
LogStatus	string	The log backup status. Valid values: Uploading: The file is being uploaded. Completed: The file has been successfully uploaded. Valores válidos: Completed : Uploading :	Completed

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "F8CA8312-530A-413A-9129-F2BB32A8D404",
  "PageNumber": 3,
  "MaxRecordsPerPage": 30,
  "TotalRecordCount": 240,
  "Items": {
    "LogFile": [
      {
        "LogFileName": "1709846151",
        "DumpDownloadURL": "null",
        "LogBeginTime": "2024-03-08T09:31:29Z",
        "DumpBucket": "null",
        "LinkExpiredTime": "null",
        "DownloadLink": "https://rdslog-shanghai.xxxxxxxxx",
        "OSSEndpoint": "null",
        "LogEndTime": "2024-03-09T02:55:00Z",
        "DumpState": 0,
        "FileSize": "603127135",
        "FileId": "5098",
        "BinLogId": "null",
        "LogStatus": "Completed"
      }
    ]
  }
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	InvalidDBInstance.Malformed	Too many instance ids or instance id format is invalid.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.