首页 云数据库 RDS API参考 API目录 备份 DescribeBinlogFiles - 查看Binlog日志

DescribeBinlogFiles - 查看Binlog日志

该接口用于查询Binlog日志。

接口说明

  • DownloadLink为NULL时,表示RDS没有提供下载链接URL。
  • DownloadLink不为NULL时,用户可以根据此URL下载备份文件,此URL已设置过期时间LinkExpiredTime,请在过期时间之前下载。
  • 返回的日志列表中包含日志记录结束时间在查询开始时间之后,并且日志记录开始时间在查询结束时间之前的所有日志。
说明本接口不适用于SQL Server实例。

调试

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

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
rds:DescribeBinlogFilesREAD
  • RDS
    acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}
  • rds:ResourceTag

请求参数

名称类型必填描述示例值
DBInstanceIdstring

实例ID。可调用DescribeDBInstances获取。

rm-uf6wjk5****
StartTimestring

查询开始时间。

格式:yyyy-MM-ddTHH:mm:ssZ(UTC时间)

2011-06-01T15:00:00Z
EndTimestring

查询结束时间,大于查询开始时间。

格式:yyyy-MM-ddTHH:mm:ssZ(UTC时间)

2011-06-20T15:00:00Z
PageSizeinteger

每页记录数。

取值:30~100

默认值:30

30
PageNumberinteger

页码,取值:大于0且不超过Integer的最大值。

默认值:1

1

返回参数

名称类型描述示例值
object

返回结果集。

TotalFileSizelong

Binlog文件总大小。

2269410
PageNumberinteger

页码。

1
RequestIdstring

请求ID。

ED169A3E-1657-4104-82AB-24EA8CD0DB75
PageRecordCountinteger

当前页Binlog文件个数。

30
TotalRecordCountinteger

Binlog文件总数。

100
Itemsobject []

Binlog明细列表。

RemoteStatusstring

OSS的存储状态。

返回值:

  • Uploading:上传中
  • Completed:上传完成
Completed
LogBeginTimestring

Binlog文件记录的开始时间。

格式:yyyy-MM-ddTHH:mm:ssZ(UTC时间)

2019-02-09T17:45:21Z
LinkExpiredTimestring

URL过期时间。

格式:yyyy-MM-ddTHH:mm:ssZ(UTC时间)

2013-06-09T18:00:00Z
LogFileNamestring

Binlog文件名称。

000000040000000000000019
Checksumstring

校验和,采用CRC64算法。

18358304393468701857
LogEndTimestring

Binlog文件记录的结束时间。

格式:yyyy-MM-ddTHH:mm:ssZ(UTC时间)

2019-02-15T13:10:28Z
HostInstanceIDstring

Binlog所在实例编号,用户区分该Binlog日志产生于主实例或备实例。

说明您可以前往RDS管理控制台,进入实例详情页,然后在左侧导航栏单击服务可用性,查看主库编号备库编号
5841973
FileSizelong

Binlog文件大小。

单位:Byte

2269410

示例

正常返回示例

JSON格式

{
  "TotalFileSize": 2269410,
  "PageNumber": 1,
  "RequestId": "ED169A3E-1657-4104-82AB-24EA8CD0DB75",
  "PageRecordCount": 30,
  "TotalRecordCount": 100,
  "Items": {
    "BinLogFile": [
      {
        "RemoteStatus": "Completed",
        "IntranetDownloadLink": "http://****.oss-cn-hangzhou-internal.aliyuncs.com/****",
        "LogBeginTime": "2019-02-09T17:45:21Z",
        "LinkExpiredTime": "2013-06-09T18:00:00Z",
        "DownloadLink": "http://****.oss.aliyuncs.com/****",
        "LogFileName": "000000040000000000000019",
        "Checksum": "18358304393468701857",
        "LogEndTime": "2019-02-15T13:10:28Z",
        "HostInstanceID": "5841973",
        "FileSize": 2269410
      }
    ]
  }
}

错误码

HTTP status code错误码错误信息描述
400ParameterLeastAssociateMust input at least one optional parameter.还原时间或备份集不能同时为空,请设置后重试。
400InvalidParameters.FormatSpecified parameter is not valid操作失败,指定的参数格式不合法。
400ParameterAbsenceNecessary parameter is absence.必要的参数未传。
400ServiceTemporarilyClosedService temporarily closed.任务关闭。
400ReadDBInstanceNotSupportThe operation is not permitted due to type of the instance.只读实例不允许执行该操作。
400InvalidStartTime.FormatSpecified start time is not valid.指定的起始时间无效。
400InvalidEndTime.FormatSpecified end time is not valid.您提交的结束时间无效,请重新提交正确信息
400InvalidParameterCombinationThe end time must be greater than the start time结束时间必须晚于开始时间。
403IncorrectDBInstanceEngineCurrent DB Instance engine does not support this operation.操作失败,数据库引擎不支持。
403IncorrectDBInstanceCharacterTypeCurrent DB Instance character_type does not support this operation.当前DB实例字符类型不支持此操作。
403IncorrectDBInstanceStateCurrent DB instance state does not support this operation.当前实例状态不支持此操作。
403IncorrectDBInstanceLockModeCurrent DB instance lock mode does not support this operation.操作失败,实例处于锁定状态。
404InvalidDBInstance.NotFoundSpecified instance does not exist or not support.指定的实例不存在指定的实例被删除或者实例不支持当前操作。

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

阿里云首页 关系型数据库 相关技术圈