该接口用于查询RDS MySQL/RDS MariaDB实例的Binlog日志或RDS PostgreSQL实例的Wal日志。
接口说明
适用引擎
- RDS MySQL
- RDS PostgreSQL
- RDS MariaDB
注意事项
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI
Explorer可以自动生成SDK代码示例。
调试
调试
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| rds:DescribeBinlogFiles | READ |
|
|
无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| 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 |
返回参数详情。 |
||
| TotalFileSize | long |
日志文件总大小。 |
2269410 |
| PageNumber | integer |
页码。 |
1 |
| RequestId | string |
请求ID。 |
ED169A3E-1657-4104-82AB-24EA8CD0DB75 |
| PageRecordCount | integer |
当前页日志文件个数。 |
30 |
| TotalRecordCount | integer |
日志文件总数。 |
100 |
| Items | object [] |
日志文件明细列表。 |
|
| RemoteStatus | string |
OSS的存储状态。 返回值：
|
Completed |
| IntranetDownloadLink | string |
内网下载链接URL。 |
http://****.oss-cn-hangzhou-internal.aliyuncs.com/**** |
| LogBeginTime | string |
日志文件记录的开始时间。 格式：yyyy-MM-ddTHH:mm:ssZ（UTC时间） |
2019-02-09T17:45:21Z |
| LinkExpiredTime | string |
URL过期时间。 格式：yyyy-MM-ddTHH:mm:ssZ（UTC时间） |
2013-06-09T18:00:00Z |
| DownloadLink | string |
支持HTTP协议的下载链接URL，NULL表示没有下载链接。 |
http://****.oss.aliyuncs.com/**** |
| LogFileName | string |
日志文件名称。 |
000000040000000000000019 |
| Checksum | string |
校验和，采用CRC64算法。 |
18358304393468701857 |
| LogEndTime | string |
日志文件记录的结束时间。 格式：yyyy-MM-ddTHH:mm:ssZ（UTC时间） |
2019-02-15T13:10:28Z |
| HostInstanceID | string |
日志文件所在实例编号，用户区分该日志文件中日志产生于主实例或备实例。 说明 | 584**** |
| FileSize | long | 日志文件大小。 单位：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 | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 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 | 结束时间必须晚于开始时间。 |
| 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. | 操作失败，实例处于锁定状态。 |
| 404 | InvalidDBInstance.NotFound | Specified instance does not exist or not support. | 指定的实例不存在指定的实例被删除或者实例不支持当前操作。 |
访问错误中心查看更多错误码。
内容没看懂？ 不太想学习？想快速解决？ 有偿解决： 联系专家
阿里云企业补贴进行中： 马上申请
腾讯云限时活动1折起，即将结束： 马上收藏
同尘科技为腾讯云授权服务中心。
购买腾讯云产品享受折上折，更有现金返利:同意关联，立享优惠
转转请注明出处：https://www.yunxiaoer.com/156523.html