全部产品
Search
文档中心

云数据库 MongoDB:DescribeBinlogFiles - 查询实例的日志备份文件

更新时间:Mar 25, 2026

查询云数据库 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

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.

访问错误中心查看更多错误码。

变更历史

更多信息,参考变更详情