文档首页/ 云数据库 TaurusDB/ API参考/ API/ 日志管理/ 查询Binlog日志列表 - ListBinlogs
更新时间:2026-11-12 GMT+08:00
分享

查询Binlog日志列表 - ListBinlogs

功能介绍

查询指定数据库实例的Binlog日志列表。

调用方法

请参见如何调用API。

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权,需具备如下身份策略权限。

    授权项

    访问级别

    资源类型(*为必须)

    条件键

    别名

    依赖的授权项

    gaussdbformysql:log:listBinlog

    List

    instance *

    • g:EnterpriseProjectId

    • g:ResourceTag/<tag-key>

    gaussdb:log:list

    -

URI

GET /v3/{project_id}/instances/{instance_id}/binlogs

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释:

租户在某一Region下的project ID。

获取方法请参见获取项目ID。

约束限制:

不涉及。

取值范围:

只能由英文字母、数字组成,且长度为32个字符。

默认取值:

不涉及。

instance_id

是

String

参数解释:

实例ID,此参数是实例的唯一标识。

获取方法请参见查询实例列表。

约束限制:

不涉及。

取值范围:

只能由英文字母、数字组成,后缀为in07,长度为36个字符。

默认取值:

不涉及。

表2 Query参数

参数

是否必选

参数类型

描述

offset

否

Integer

参数解释:

索引位置,偏移量。从第一条数据偏移offset条数据后开始查询。

约束限制:

必须为整数,不能为负数。

取值范围:

≥0。

默认取值:

0。

limit

否

Integer

参数解释:

查询记录数。

约束限制:

不涉及。

取值范围:

  • 10:10条。

  • 20:20条。

  • 50:50条。

默认取值:

10。

begin_time

否

String

参数解释:

开始时间,格式为"yyyy-mm-ddThh:mm:ssZ"。

其中,T指某个时间的开始;Z指时区偏移量,例如偏移1个小时显示为+0100。

约束限制:

小于等于end_time。

取值范围:

不涉及。

默认取值:

不涉及。

end_time

否

String

参数解释:

结束时间,格式为"yyyy-mm-ddThh:mm:ssZ"。

其中,T指某个时间的开始;Z指时区偏移量,例如偏移1个小时显示为+0100。

约束限制:

大于等于begin_time。

取值范围:

不涉及。

默认取值:

不涉及。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释:

用户Token。通过调用IAM服务获取用户Token接口获取。

请求响应成功后在响应消息头中包含的"X-Subject-Token"的值即为Token值。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

X-Language

否

String

参数解释:

请求语言类型。

约束限制:

不涉及。

取值范围:

  • en-us:英文。

  • zh-cn:中文。

默认取值:

en-us。

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

total_count

Integer

参数解释:

Binlog日志文件总数。

取值范围:

不涉及。

binlogs

Array of BinlogInfo objects

参数解释:

Binlog日志文件列表。

表5 BinlogInfo

参数

参数类型

描述

id

String

参数解释:

Binlog日志文件ID。

取值范围:

不涉及。

name

String

参数解释:

Binlog日志文件名称。

取值范围:

不涉及。

instance_id

String

参数解释:

Binlog日志对应的实例ID。

取值范围:

不涉及。

instance_name

String

参数解释:

Binlog日志对应的实例名称。

取值范围:

不涉及。

size

Long

参数解释:

Binlog日志文件大小,单位是KB。

取值范围:

不涉及。

begin_time

String

参数解释:

Binlog日志文件中上一轮任务的最后一个事务的提交时间。

取值范围:

不涉及。

end_time

String

参数解释:

Binlog日志文件中最后一个事务的提交时间。

取值范围:

不涉及。

状态码:400

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

状态码:500

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

请求示例

查询实例的Binlog日志列表。

GET https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/61a4ea66210545909d74a05c27a7179ein07/binlogs?offset=0&limit=10&begin_time=2023-07-06T10:41:14+0800&end_time=2023-07-07T10:41:14+0800

响应示例

状态码:200

{
  "total_count" : 1,
  "binlogs" : [ {
    "id" : "43e4feaab48f11e89039fa163ebaa7e4br07",
    "name" : "xxxx.xxx",
    "instance_id" : "f3cd377d94bc4be783571aea7de08409in07",
    "instance_name" : "taurusdb-e213",
    "size" : 2803,
    "begin_time" : "2023-09-06T12:41:14+0800",
    "end_time" : "2023-09-06T12:43:14+0800"
  } ]
}

状态码

状态码

描述

200

Success.

400

Client error.

500

Server error.

错误码

请参见错误码。

相关文档