文档中心>云数据库 MySQL>API 文档>备份相关接口>查询二进制日志备份文件列表

查询二进制日志备份文件列表

最近更新时间:2024-03-12 01:13:40

我的收藏

1. 接口描述

接口请求域名: cdb.tencentcloudapi.com 。

本接口(DescribeBinlogs)用于查询云数据库实例的 binlog 文件列表。

默认接口请求频率限制:100次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeBinlogs。
Version String 公共参数,本接口取值:2017-03-20。
Region String 公共参数,详见产品支持的 地域列表
InstanceId String 实例 ID,格式如:cdb-c1nl9rpv。与云数据库控制台页面中显示的实例 ID 相同。
示例值:cdb-c1nl9rpv
Offset Integer 偏移量,最小值为0。
示例值:0
Limit Integer 分页大小,默认值为20,最小值为1,最大值为100。
示例值:0
MinStartTime String binlog最早开始时间,时间格式:2016-03-17 02:10:37
示例值:""
MaxStartTime String binlog最晚开始时间,时间格式:2016-03-17 02:10:37
示例值:""
ContainsMinStartTime Boolean 返回binlog列表是否包含MinStartTime起始节点,默认为否

3. 输出参数

参数名称 类型 描述
TotalCount Integer 符合查询条件的日志文件总数。
示例值:2
Items Array of BinlogInfo 符合查询条件的二进制日志文件详情。
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询二进制日志

查询二进制日志

输入示例

POST / HTTP/1.1
Host: cdb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeBinlogs
<公共请求参数>

{
    "InstanceId": "cdb-c1nl9rpv"
}

输出示例

{
    "Response": {
        "Items": [
            {
                "BinlogFinishTime": "2020-11-12 21:13:12",
                "BinlogStartTime": "2020-11-12 21:13:04",
                "Date": "2020-11-12 21:13:35",
                "InternetUrl": "https://*****",
                "IntranetUrl": "https://*****",
                "Name": "cdb73977_binlog_mysqlbin.000004",
                "Size": 505,
                "Status": "FINISHED",
                "Region": "ap-guangzhou",
                "CosStorageType": 0,
                "RemoteInfo": [],
                "Type": "binlog",
                "InstanceId": "cdb-xxx"
            },
            {
                "BinlogFinishTime": "2020-11-12 21:13:04",
                "BinlogStartTime": "2020-11-02 11:38:49",
                "Date": "2020-11-12 21:13:25",
                "InternetUrl": "https://*****",
                "IntranetUrl": "https://*****",
                "Name": "cdb73977_binlog_mysqlbin.000003",
                "Size": 4537,
                "Status": "FINISHED",
                "Region": "ap-guangzhou",
                "CosStorageType": 0,
                "RemoteInfo": [],
                "Type": "binlog",
                "InstanceId": "cdb-xxx"
            }
        ],
        "RequestId": "2d8504a5-157d-4753-a060-6464b0e875e5",
        "TotalCount": 2
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
AuthFailure CAM签名/鉴权错误。
InternalError.CdbError 系统错误。
InternalError.DBError 数据库异常。
InternalError.DBOperationError 数据库操作失败。
InternalError.DatabaseAccessError 数据库内部错误。
InternalError.HttpError Http请求异常。
InternalError.UnknownError 未知错误。
InvalidParameter 参数错误。
InvalidParameter.InstanceNotFound 实例不存在。
InvalidParameterValue.InvalidParameterValueError 参数值无效。
OperationDenied 操作被拒绝。