文档

DescribeBinlogFiles - 查看RDS实例的日志(Binglog/Wal)文件

更新时间:

该接口用于查询RDS MySQL/RDS MariaDB实例的Binlog日志或RDS PostgreSQL实例的Wal日志。

接口说明

适用引擎

  • RDS MySQL
  • RDS PostgreSQL
  • RDS MariaDB

注意事项

  • DownloadLink 为 NULL 时,表示 RDS 没有提供下载链接 URL。
  • DownloadLink 不为 NULL 时,用户可以根据此 URL 下载备份文件,此 URL 已设置过期时间 LinkExpiredTime,请在过期时间之前下载。
  • 当通过 RAM 账号下载备份文件时,需要为 RAM 账号授权,详情请参见添加下载备份文件权限给只读 RAM 账号
  • 返回的日志列表中包含日志记录结束时间在查询开始时间之后,并且日志记录开始时间在查询结束时间之前的所有日志。

调试

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

授权信息

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

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

日志文件总大小。

2269410
PageNumberinteger

页码。

1
RequestIdstring

请求 ID。

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

当前页日志文件个数。

30
TotalRecordCountinteger

日志文件总数。

100
Itemsobject []

日志文件明细列表。

RemoteStatusstring

OSS 的存储状态。

返回值:

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

日志文件记录的开始时间。

格式: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

日志文件名称。

000000040000000000000019
Checksumstring

校验和,采用 CRC64 算法。

18358304393468701857
LogEndTimestring

日志文件记录的结束时间。

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

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

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

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

日志文件大小。

单位: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": "584****",
        "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结束时间必须晚于开始时间。
400Order.ComboInstanceNotAllowOperateA package instance is not allowed to operate independently.套餐实例不允许单独操作。
400Price.PricingPlanResultNotFoundPricing plan price result not found.定价计划价格结果没有找到。
400Order.NoRealNameAuthenticationYou have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.您还未通过实名认证,不符合购买条件,请登录用户中心进行实名认证。
400InsufficientAvailableQuotaYour account quota limit is less than 0, please recharge before trying to purchase.您的账户可用额度小于0,请先充值后再尝试购买。
400CommodityServiceCalling.ExceptionFailed to call commodity service.调用商品服务返回失败。
400RegionDissolvedEOMDear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.客户您好,阿里云计划对当前地域进行优化调整,该区域云服务将停止运营,为确保您的业务连续性及数据迁移工作的平稳过渡,您目前无法操作新购类型的订单,感谢理解与支持。
400Commodity.InvalidComponentThe module you purchased is not legal, please buy it again.您购买的模块不合法,请重新购买。
400RegionEndTimeDissolvedIndiaCloud services in the India (Mumbai) region will be discontinued. Set the validity date to July 15, 2024 or earlier than July 15, 2024.客户您好,印度地域裁撤,购买的服务效期不能超过2024.07.15。
400RegionEndTimeDissolvedAustraliaCloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.客户您好,澳洲地域裁撤,购买的服务效期不能超过2024.09.30
400Price.CommoditySysCommodity system call exception.商品系统调用异常。
400Pay.InsufficientBalanceInsufficient available balance.可用金不足。
400Order.PeriodInvalidThere is a problem with the period you selected, please choose again.您选购的周期有问题,请重新选购。
400pay.noCreditCardAccount not bound to credit card.账户未绑定信用卡。
400Order.InstHasUnpaidOrderThere is an unpaid order for the service you have purchased. Please pay or void it before placing the order.您选购的服务存在未支付订单,请支付或作废后再下单。
400noAvailablePaymentMethodNo payment method is specified for your account. We recommend that you add a payment method.没有为您的帐户指定付款方式。我们建议您添加一种付款方式。
400BasicInfoUncompletedYour information is incomplete. Complete your information before the operation.您的基本信息未完善,请在操作前先完善您的基本信息。
400Risk.RiskControlRejectionYour account is abnormal, please contact customer service for details.您的账户出现异常,详情请联系客服。
400BasicInfoUncompletedYour information is incomplete, Complete your information before the operation.您的信息不完整,请在操作前填写您的信息。
400Api.NotSupportSpecified api is not supported.当前接口不支持。
400ContainForbiddenLabelErrorThere is a label that prohibits placing orders. Please contact your distributor for assistance.存在禁止下单的标签,请联系您的分销商处理
400InvalidDBInstanceId.NotFoundThe DBInstanceId provided does not exist in records.提供的DBInstanceId不存在。
400InvalidInstanceLevel.DiskTypeSpecified instance level not support request disk type当前实例规格不支持该存储类型。
400InvalidParamSepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.指定的 wal_level 参数无效。实例中仍然存在复制槽,因此无法将其设置为replica。
400KmsApiErrorUser secret key invalid.用户密钥失效。
400System.SaleValidateFailedSales expression validation system error.销售表达式校验系统错误。
400Abs.InvalidAccount.NotFoundaccount is not found.账户不存在。
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.操作失败,实例处于锁定状态。
403OrderStatus.UnPaidThe specified db instance has unpaid order.实例当前存在未支付订单,请支付后重试。
403InvalidReduceDiskSizeThe storage capacity after the scale-down must be larger than the used amount.缩容目标容量不能小于当前存储空间使用量
403CloudSSDNotSupportCloud ssd does not support this operation, please upgrade to essd.SSD盘不支持此操作,请升级至ESSD。
403InvalidUserOperatorPermissionThe user permission does not support this operation.用户权限不支持此操作。
403InvalidVswitchIdSpecified conn vswitch id is not valid.指定的VSwitchId格式不正确或为空
404InvalidDBInstance.NotFoundSpecified instance does not exist or not support.指定的实例不存在指定的实例被删除或者实例不支持当前操作。
404InvalidClusterKmsThe current instance does not authorized to access the Key Management Service.当前实例未授权访问密钥管理服务。
500ExternalFailureThe request processing has failed due to external service failure.请求服务失败,请稍后重试。

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

  • 本页导读 (1)