DescribeBinlogFiles - ApsaraDB for MongoDB - Alibaba Cloud Documentation Center

Query log backup files for an ApsaraDB for MongoDB instance.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The ID of the region.	cn-zhangjiakou
DBInstanceId	string	Yes	The ID of the instance. If the instance is a sharded cluster, you must also specify the NodeId parameter.	dds-wz9ca592fc637a54
NodeId	string	No	The ID of the mongos node or shard node in the sharded cluster instance. Note This parameter is applicable only to sharded cluster instances.	d-uf696817a1b5d9f4
StartTime	string	Yes	The start time of the query. The time is in the yyyy-MM-ddTHH:mm:ss.xxxZ format. The time is displayed in UTC.	2021-03-23T06:24:21.425Z
EndTime	string	Yes	The end time of the query. The time must be later than the start time. The time is in the yyyy-MM-ddTHH:mm:ss.xxxZ format. The time is displayed in UTC.	2023-04-17T05:50:28.914Z
PageSize	integer	No	The number of entries to return on each page.	10
PageNumber	integer	No	The page number.	1
SrcRegion	string	No	The region of the source instance for a cross-region backup. Note This parameter is required when you query cross-region backups.	ap-southeast-1
DestRegion	string	No	The region where the cross-region backup is stored. Note This parameter is required when you query cross-region backups.	cn-beijing
BinlogId	string	No	The binlog ID. This parameter is not currently supported.	null
ResourceGroupId	string	No	The resource group ID.	rg-xxxx

Response elements

Element	Type	Description	Example
	object
RequestId	string	The ID of the request.	F8CA8312-530A-413A-9129-F2BB32A8D404
PageNumber	integer	The page number of the returned results.	3
MaxRecordsPerPage	integer	The number of entries to return on each page.	30
TotalRecordCount	integer	The total number of binlog files found.	240
Items	object
LogFile	array<object>	The details of the binlog files.
	object	The details of a binlog file.
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. Valid values: Completed : Uploading :	Completed

Examples

Success response

JSON format

{
  "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"
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidDBInstance.Malformed	Too many instance ids or instance id format is invalid.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.