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:DescribeBinlogFiles	get	*DBInstance `acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}`	rds:ResourceTag	无

请求参数

名称	类型	必填	描述	示例值

名称	类型	必填	描述	示例值
DBInstanceId	string	是	实例 ID。可调用 DescribeDBInstances 获取。	rm-uf6wjk5****
StartTime	string	是	查询开始时间。格式：yyyy-MM-ddTHH:mm:ssZ（UTC 时间）	2011-06-01T15:00:00Z
EndTime	string	是	查询结束时间，大于查询开始时间。格式：yyyy-MM-ddTHH:mm:ssZ（UTC 时间）	2011-06-20T15:00:00Z
PageSize	integer	否	每页记录数。取值：30~100 默认值：30	30
PageNumber	integer	否	页码，取值：大于 0 且不超过 Integer 的最大值。默认值：1	1

返回参数

名称	类型	描述	示例值

名称	类型	描述	示例值
	object	返回参数详情。
Items	array<object>	日志文件明细列表。
BinLogFile	object	日志文件详情。
Checksum	string	校验和，采用 CRC64 算法。	18358304393468701857
DownloadLink	string	支持 HTTP 协议的下载链接 URL，NULL 表示没有下载链接。	http://**.oss.aliyuncs.com/**
FileSize	long	日志文件大小。单位：Byte	2269410
HostInstanceID	string	日志文件所在实例编号，用户区分该日志文件中日志产生于主实例或备实例。说明您可以前往 RDS 管理控制台，进入实例详情页，然后在左侧导航栏单击服务可用性，查看主库编号和备库编号。	584****
IntranetDownloadLink	string	内网下载链接 URL。	http://**.oss-cn-hangzhou-internal.aliyuncs.com/**
LinkExpiredTime	string	URL 过期时间。格式：yyyy-MM-ddTHH:mm:ssZ（UTC 时间）	2013-06-09T18:00:00Z
LogBeginTime	string	日志文件记录的开始时间。格式：yyyy-MM-ddTHH:mm:ssZ（UTC 时间）	2019-02-09T17:45:21Z
LogEndTime	string	日志文件记录的结束时间。格式：yyyy-MM-ddTHH:mm:ssZ（UTC 时间）	2019-02-15T13:10:28Z
LogFileName	string	日志文件名称。	000000040000000000000019
RemoteStatus	string	OSS 的存储状态。返回值： Uploading：上传中 Completed：上传完成	Completed
PageNumber	integer	页码。	1
PageRecordCount	integer	当前页日志文件个数。	30
RequestId	string	请求 ID。	ED169A3E-1657-4104-82AB-24EA8CD0DB75
TotalFileSize	long	日志文件总大小。	2269410
TotalRecordCount	integer	日志文件总数。	100

示例

正常返回示例

JSON格式

        

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

错误码

HTTP status code	错误码	错误信息	描述

HTTP status code	错误码	错误信息	描述
400	ParameterLeastAssociate	Must input at least one optional parameter.	还原时间或备份集不能同时为空，请设置后重试。
400	InvalidParameters.Format	Specified parameter is not valid	操作失败，指定的参数格式不合法。
400	ParameterAbsence	Necessary parameter is absence.	必要的参数未传。
400	ServiceTemporarilyClosed	Service temporarily closed.	任务关闭。
400	ReadDBInstanceNotSupport	The operation is not permitted due to type of the instance.	只读实例不允许执行该操作。
400	InvalidStartTime.Format	Specified start time is not valid.	指定的起始时间无效。
400	InvalidEndTime.Format	Specified end time is not valid.	您提交的结束时间无效，请重新提交正确信息
400	InvalidParameterCombination	The end time must be greater than the start time	结束时间必须晚于开始时间。
400	Order.ComboInstanceNotAllowOperate	A package instance is not allowed to operate independently.	套餐实例不允许单独操作。
400	Price.PricingPlanResultNotFound	Pricing plan price result not found.	定价计划价格结果没有找到。
400	Order.NoRealNameAuthentication	You 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.	您还未通过实名认证，不符合购买条件，请登录费用与成本进行实名认证。
400	InsufficientAvailableQuota	Your account quota limit is less than 0, please recharge before trying to purchase.	您的账户可用额度小于0，请先充值后再尝试购买。
400	CommodityServiceCalling.Exception	Failed to call commodity service.	调用商品服务返回失败。
400	RegionDissolvedEOM	Dear 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.	客户您好，阿里云计划对当前地域进行优化调整，该区域云服务将停止运营，为确保您的业务连续性及数据迁移工作的平稳过渡，您目前无法操作新购类型的订单，感谢理解与支持。
400	Commodity.InvalidComponent	The module you purchased is not legal, please buy it again.	您购买的模块不合法，请重新购买。
400	RegionEndTimeDissolvedAustralia	Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.	客户您好，该地域已裁撤。
400	Price.CommoditySys	Commodity system call exception.	商品系统调用异常。
400	Pay.InsufficientBalance	Insufficient available balance.	可用金不足。
400	Order.PeriodInvalid	There is a problem with the period you selected, please choose again.	您选购的周期有问题，请重新选购。
400	pay.noCreditCard	Account not bound to credit card.	账户未绑定信用卡。
400	Order.InstHasUnpaidOrder	There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.	您选购的服务存在未支付订单，请支付或作废后再下单。
400	noAvailablePaymentMethod	No payment method is specified for your account. We recommend that you add a payment method.	没有为您的帐户指定付款方式。我们建议您添加一种付款方式。
400	BasicInfoUncompleted	Your information is incomplete. Complete your information before the operation.	您的基本信息未完善，请在操作前先完善您的基本信息。
400	Risk.RiskControlRejection	Your account is abnormal, please contact customer service for details.	您的账户出现异常，详情请联系客服。
400	BasicInfoUncompleted	Your information is incomplete, Complete your information before the operation.	您的信息不完整，请在操作前填写您的信息。
400	Api.NotSupport	Specified api is not supported.	当前接口不支持。
400	ContainForbiddenLabelError	There is a label that prohibits placing orders. Please contact your distributor for assistance.	存在禁止下单的标签，请联系您的分销商处理
400	InvalidDBInstanceId.NotFound	The DBInstanceId provided does not exist in records.	提供的DBInstanceId不存在。
400	InvalidInstanceLevel.DiskType	Specified instance level not support request disk type	当前实例规格不支持该存储类型。
400	InvalidParam	Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.	指定的 wal_level 参数无效。实例中仍然存在复制槽，因此无法将其设置为replica。
400	KmsApiError	User secret key invalid.	用户密钥失效。
400	System.SaleValidateFailed	Sales expression validation system error.	销售表达式校验系统错误。
400	Abs.InvalidAccount.NotFound	account is not found.	账户不存在。
400	SqlExecuteFailedOrTimeout	sql command execution failed or timed out:%s.	sql命令执行失败或执行超时
400	ColdData.EngineVersionNotSupport	The current instance engine version not support coldDataEnabled.	当前实例引擎版本不支持归档冷数据。
400	ColdData.MinorVersionNotSupport	The current instance minor version not support coldDataEnabled.	当前内核版本不支持归档冷数据。
400	IncorrectTargetClasscode	The current instance type does not support this operation.	当前规格不支持此操作。
400	InvalidConnectionString.Duplicate	Specified connection string already exists in the RDS.	链接地址名重复，请重新设置连接字符串。
400	RequiredParam.NotFound	Required input param is not found.	没有传入必要的参数。
400	Parameters.Invalid	Parameter error, please check the parameters.	参数错误，请检查参数。
400	BackupPolicyNotSupport	Cold Data won't open with CrossBackup or Flash Backup, please check Backup Policy.	数据归档不支持跨地域备份和秒级快照，请检查备份策略。
400	InvalideStatus.Format	The instance status does not support this operation.	实例状态不支持此操作。
400	InvalidReleasedKeepPolicy.Format	Specified Released Keep Policy is not valid.	实例释放后的归档备份保留策略无效。
400	InvalidDBInstanceEngineType.Format	the DB instance engine type does not support this operation.	DB实例引擎类型不支持此操作。
400	Pay.NoCreditCard	No credit cards.	无信用卡。
400	VpcNetworkTypeNotSupport	The vpc network type instance does not support this operation.	vpc网络类型实例不支持此操作。
400	MirrorInsExists	Specified DB instance mirror ins already existed.	当前数据库实例镜像已存在。
400	UnsupportedClassCode	The specified DB instance class stops selling.	实例规格停止售卖。
400	InvalidBackupSet	The specified database does not exist in the backup set.	备份集中没有指定的数据库。
400	OrdTCommodityQueryError	Failed to query for product.	查询产品失败。
400	ProductInstanceReleased	The instance has been released. Please check before placing the order.	实例已释放，请核实后下单。
400	RegionEndTimeDissolvedIndia	The region is no longer supported.	指定的地域无效。
403	IncorrectDBInstanceEngine	Current DB Instance engine does not support this operation.	操作失败，数据库引擎不支持。
403	IncorrectDBInstanceCharacterType	Current DB Instance character_type does not support this operation.	当前DB实例字符类型不支持此操作。
403	IncorrectDBInstanceState	Current DB instance state does not support this operation.	当前实例状态不支持此操作。
403	IncorrectDBInstanceLockMode	Current DB instance lock mode does not support this operation.	操作失败，实例处于锁定状态。
403	OrderStatus.UnPaid	The specified db instance has unpaid order.	实例当前存在未支付订单，请支付后重试。
403	InvalidReduceDiskSize	The storage capacity after the scale-down must be larger than the used amount.	缩容目标容量不能小于当前存储空间使用量
403	CloudSSDNotSupport	Cloud ssd does not support this operation, please upgrade to essd.	SSD盘不支持此操作，请升级至ESSD。
403	InvalidUserOperatorPermission	The user permission does not support this operation.	用户权限不支持此操作。
403	InvalidVswitchId	Specified conn vswitch id is not valid.	指定的VSwitchId格式不正确或为空
403	IncorrectMinorVersion	Current engine minor version does not support operations.	当前引擎小版本不支持此操作。
403	OperationDenied.ZoneResource	There is no available zone for inventory.	没有可用的库存区域。
403	NotInFlowController	Sorry,no permission.	非集团上云用户不可用，无权限。
403	InvalidKmsKey	Kms key is disabled.	Kms key已禁用。
403	InvalidInstanceLevel.Malformed	Current DB instance level does not support this operation.	当前数据库实例级别不支持此操作。
404	InvalidDBInstance.NotFound	Specified instance does not exist or not support.	指定的实例不存在指定的实例被删除或者实例不支持当前操作。
404	InvalidClusterKms	The current instance does not authorized to access the Key Management Service.	当前实例未授权访问密钥管理服务。
404	Request.NotFound	The requested resource is not available.	请求的资源不可用。
404	HostInfo.NotFound	The specified host info is not found.	指定的主机信息不存在。
500	ExternalFailure	The request processing has failed due to external service failure.	请求服务失败，请稍后重试。
500	RequestMetaDataFailed	The service request failed. Please try again later or contact service personnel.	请求服务失败，请稍后再试或联系服务人员。
500	InvokeProxyFailure	The request processing has failed due to service failure of rds api.	由于rds api服务失败，请求处理失败。

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

变更历史

变更时间	变更内容概要	操作

变更时间	变更内容概要	操作
2024-11-22	OpenAPI 描述信息更新、OpenAPI 错误码发生变更	查看变更详情