DescribeBinlogFiles - 查詢執行個體的記錄備份檔案 - ApsaraDB for MongoDB

查詢ApsaraDB for MongoDB執行個體的記錄備份檔案

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

授權資訊

當前API暫無授權資訊透出。

請求參數

名稱	類型	必填	描述	樣本值
RegionId	string	否	地區 ID。	cn-zhangjiakou
DBInstanceId	string	是	執行個體 id。當本參數傳入的是分區叢集執行個體 id 時，還需要傳入 nodeid 參數。	dds-wz9ca592fc637a54
NodeId	string	否	分區叢集執行個體中 Mongos 節點 ID 或 Shard 節點 ID。說明當 DBInstanceId 參數傳入的是分區叢集執行個體 ID 時，本參數才可用。	d-uf696817a1b5d9f4
StartTime	string	是	查詢開始時間，格式為yyyy-MM-ddTHH:mm:ss.xxxZ（UTC 時間）。	2021-03-23T06:24:21.425Z
EndTime	string	是	查詢結束時間，必須晚於查詢開始時間，格式為yyyy-MM-ddTHH:mm:ss.xxxZ（UTC 時間）。	2023-04-17T05:50:28.914Z
PageSize	integer	否	每頁可展示的記錄數。	10
PageNumber	integer	否	頁碼。	1
SrcRegion	string	否	異地備份源執行個體所在地區。說明當查詢的是異地備份時，需要且必填。	ap-southeast-1
DestRegion	string	否	異地備份所在地區。說明查詢異地備份時，該參數必填。	cn-beijing
BinlogId	string	否	Binlog 日誌 ID（暫未支援）	null
ResourceGroupId	string	否	資源群組 ID	rg-xxxx

返回參數

名稱	類型	描述	樣本值
	object
RequestId	string	請求 ID。	F8CA8312-530A-413A-9129-F2BB32A8D404
PageNumber	integer	頁碼。	3
MaxRecordsPerPage	integer	每頁記錄數。	30
TotalRecordCount	integer	binlog 檔案總數。	240
Items	object
LogFile	array<object>	binlog 明細列表。
	object	binlog 明細列表。
LogFileName	string	binlog 檔案名稱。	1709846151
DumpDownloadURL	string	binlog 檔案 oss 下載連結。（暫未支援）	null
LogBeginTime	string	記錄檔記錄的開始時間。格式：yyyy-MM-ddTHH:mm:ssZ（UTC 時間）	2024-03-08T09:31:29Z
DumpBucket	string	binlog 檔案儲存體位置。（暫未支援）	null
LinkExpiredTime	string	URL 到期時間。（暫不支援）	null
DownloadLink	string	binlog 檔案的下載連結 url。	https://rdslog-shanghai.xxxxxxxxx
OSSEndpoint	string	binlog 檔案所在 oss 的 endpoint。（暫未支援）	null
LogEndTime	string	binlog 結束時間，格式為yyyy-MM-ddTHH:mmZ（UTC 時間）。	2024-03-09T02:55:00Z
DumpState	integer	dump 狀態。（暫未支援）	null
FileSize	string	Binlog 檔案大小。單位：Byte	603127135
FileId	string	binlog 檔案 id。	5098
BinLogId	string	Binlog 日誌 ID（暫未支援）	null
LogStatus	string	記錄備份狀態。傳回值： Uploading：上傳中 Completed：上傳完成枚舉值： Completed : Completed Uploading : Uploading	Completed

樣本

正常返回樣本

JSON格式

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

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
400	InvalidDBInstance.Malformed	Too many instance ids or instance id format is invalid.

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。