调用DescribeBinaryLogList接口查询Binlog日志。

  • binlog文件默认保存15天。
  • 返回的日志列表中包含日志记录结束时间在查询开始时间之后，并且日志记录开始时间在查询结束时间之前的所有日志。
  • 当DownloadLink不为NULL时，用户可以根据此URL下载备份文件，此URL自生成后2天内有效，请在过期时间之前下载。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 DescribeBinaryLogList

系统规定参数。取值：DescribeBinaryLogList。
RegionId String 是 cn-hangzhou

实例所在地域ID。
PageNumber Integer 否 1

分页获取当前binlog列表时，需填写当前页码，默认从第1页开始。
PageSize Integer 否 30

每页获取binlog数量，默认填写30。
DBInstanceName String 是 pxc-hzfd13214******

当前实例名称。
StartTime String 是 2021-09-09 10:27:46

查询binlog列表开始时间。
EndTime String 是 2021-11-09 10:27:46

查询binlog列表结束时间。
InstanceName String 否 pxc-hzfd13214******-cdc

CDC实例名称，默认会查询单流binlog列表。

返回数据

名称 类型 示例值 描述
RequestId String 2DFF784E-DC31-5BBC-9B25-9261CD9E0AA9

请求ID。
PageNumber Integer 1

当前查询的页码。
PageSize Integer 30

当前页显示的binlog数量。
TotalNumber Integer 100

查询到的binlog文件总数。
LogList Array of LogList

binlog文件列表。
EndTime String 2021-11-09 10:27:46

当前binlog结束时间。
ModifiedTime String 2021-11-09 10:27:46

最后更新时间。
UploadHost String 10.110.88.9

备份host。
UploadStatus Integer 2

备份状态：

  • 0：未备份；
  • 1：备份中；
  • 2：已备份。
DownloadLink String http://polarx-cdc-binlog-cn-hangzhou.oss-cn-hangzhou.aliyuncs.com/polardbx_cdc/pxc-hzfd13214******/binlog.000001?Expires=1636469502&OSSAccessKeyId=LT13fds12ds******&Signature=fdpm%bdsfadsa%2F%bdsafd******

文件下载链接，2天内有效。
BeginTime String 2021-09-09 10:27:46

日志开始时间。
LogSize Long 536870912

当前日志文件大小，单位：字节。
FileName String binlog.000001

binlog文件名称。
CreatedTime String 2021-09-09 10:27:46

文件创建时间。
PurgeStatus Integer 0

清理状态：

  • 0：未删除；
  • 1：已删除。
Id Long 100

当前记录的唯一ID。

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeBinaryLogList
&RegionId=cn-hangzhou
&PageNumber=1
&PageSize=30
&DBInstanceName=pxc-hzfd13214******
&StartTime=2021-09-09 10:27:46
&EndTime=2021-11-09 10:27:46
&InstanceName=pxc-hzfd13214******-cdc
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeBinaryLogListResponse>
    <RequestId>2DFF784E-DC31-5BBC-9B25-9261CD9E0AA9</RequestId>
    <PageNumber>1</PageNumber>
    <PageSize>30</PageSize>
    <TotalNumber>100</TotalNumber>
    <LogList>
        <EndTime>2021-11-09 10:27:46</EndTime>
        <ModifiedTime>2021-11-09 10:27:46</ModifiedTime>
        <UploadHost>10.110.88.9</UploadHost>
        <UploadStatus>2</UploadStatus>
        <DownloadLink>http://polarx-cdc-binlog-cn-hangzhou.oss-cn-hangzhou.aliyuncs.com/polardbx_cdc/pxc-hzfd13214******/binlog.000001?Expires=1636469502&amp;OSSAccessKeyId=LT13fds12ds******&amp;Signature=fdpm%bdsfadsa%2F%bdsafd******</DownloadLink>
        <BeginTime>2021-09-09 10:27:46</BeginTime>
        <LogSize>536870912</LogSize>
        <FileName>binlog.000001</FileName>
        <CreatedTime>2021-09-09 10:27:46</CreatedTime>
        <PurgeStatus>0</PurgeStatus>
        <Id>100</Id>
    </LogList>
</DescribeBinaryLogListResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "2DFF784E-DC31-5BBC-9B25-9261CD9E0AA9",
  "PageNumber" : 1,
  "PageSize" : 30,
  "TotalNumber" : 100,
  "LogList" : [ {
    "EndTime" : "2021-11-09 10:27:46",
    "ModifiedTime" : "2021-11-09 10:27:46",
    "UploadHost" : "10.110.88.9",
    "UploadStatus" : 2,
    "DownloadLink" : "http://polarx-cdc-binlog-cn-hangzhou.oss-cn-hangzhou.aliyuncs.com/polardbx_cdc/pxc-hzfd13214******/binlog.000001?Expires=1636469502&OSSAccessKeyId=LT13fds12ds******&Signature=fdpm%bdsfadsa%2F%bdsafd******",
    "BeginTime" : "2021-09-09 10:27:46",
    "LogSize" : 536870912,
    "FileName" : "binlog.000001",
    "CreatedTime" : "2021-09-09 10:27:46",
    "PurgeStatus" : 0,
    "Id" : 100
  } ]
}

错误码

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