文档首页/数据管理服务 DAS/API参考/API（公测中）/云DBA/查询binlog文件列表 - BinlogListFile
更新时间：2026-01-07 GMT+08:00
查看PDF
分享

查询binlog文件列表 - BinlogListFile

功能介绍

查询binlog文件列表。

授权信息

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

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

    授权项

    访问级别

    资源类型（*为必须）

    条件键

    别名

    依赖的授权项

    das:clouddba:listBinlog

    list

    instance

    -

    -

    -

URI

POST /v3/{project_id}/connections/{connection_id}/binlog-parse/list-file

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

租户在某一Region下的项目ID。

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

约束限制：

不涉及。

取值范围：

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

默认取值：

不涉及。

connection_id

是

String

参数解释：

连接ID。用户使用数据库账号与数据库建立的连接ID（数据库用户ID由创建实例连接创建）。

约束限制：

不涉及。

取值范围：

只能由英文字母、数字、中划线组成，且长度为36个字符的UUID。

默认取值：

不涉及。

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

binlog_type

是

String

参数解释：

binlog文件类型。

约束限制：

不涉及。

取值范围：

  • latest：最近日志
  • backup：归档日志

默认取值：

不涉及。

start_time

否

Long

参数解释：

开始时间（Unix timestamp），单位：毫秒。

约束限制：

不涉及。

取值范围：

[0, 2^31-1]，实际取决于查询。

默认取值：

不涉及。

end_time

否

Long

参数解释：

结束时间（Unix timestamp），单位：毫秒。

约束限制：

不涉及。

取值范围：

[0, 2^31-1]，实际取决于查询。

默认取值：

不涉及。

cur_page

否

Integer

参数解释：

每页记录数。

约束限制：

不涉及。

取值范围：

[0, 100]，实际取决于查询。

默认取值：

不涉及。

per_page

否

Integer

参数解释：

页码。

约束限制：

不涉及。

取值范围：

[0, 2^31-1]，实际取决于查询。

默认取值：

不涉及。

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

total

Integer

参数解释：

总数。

取值范围：

[0, 2^31-1]

file_list

Array of 表4 objects

参数解释：

binlog文件列表。

取值范围：

不涉及

表4 BinlogFileInfo

参数

参数类型

描述

file_name

String

参数解释：

文件名称。

取值范围：

不涉及。

backup_id

String

参数解释：

备份ID。

取值范围：

不涉及。

file_size

Long

参数解释：

文件大小。

取值范围：

不涉及。

task_info

BinlogParseTaskInfo object

参数解释：

归档日志解析信息。

取值范围：

不涉及。

表5 BinlogParseTaskInfo

参数

参数类型

描述

id

Long

参数解释：

任务ID。

取值范围：

[0, 2^31-1]

gmt_create

Long

参数解释：

任务创建时间，单位：毫秒。

取值范围：

不涉及。

gmt_modified

Long

参数解释：

任务修改时间，单位：毫秒。

取值范围：

不涉及。

tenant_id

String

参数解释：

租户ID。

取值范围：

不涉及。

tenant_name

String

参数解释：

租户名称。

取值范围：

不涉及。

user_id

String

参数解释：

用户ID。

取值范围：

不涉及。

user_name

String

参数解释：

用户名称。

取值范围：

不涉及。

connection_id

String

参数解释：

连接ID。用户使用数据库账号与数据库建立的连接ID（数据库用户ID由创建实例连接接口创建）。

取值范围：

只能由英文字母、数字、中划线组成，且长度为36个字符的UUID。

binlog_type

String

参数解释：

binlog类型。

取值范围：

  • latest：最近日志
  • backup：归档日志

file_name

String

参数解释：

binlog文件名称。

取值范围：

不涉及。

backup_id

String

参数解释：

备份文件ID。

取值范围：

不涉及。

status

Integer

参数解释：

任务状态。

取值范围：

  • 0：初始化
  • 1：运行中
  • 2：部分成功
  • 3：成功
  • 4：失败
  • -1：已删除

err_msg

String

参数解释：

错误信息。

取值范围：

不涉及。

请求示例

POST https://das.cn-north-1.myhuaweicloud.com/v3/054e292c9880d4992f02c0196d3ea468/connections/179e525e-0e9c-4dcc-9dd7-ee2f36121e23/binlog-parse/list-file
 
{
  "binlog_type": "backup",
  "cur_page": 1,
  "per_page": 10,
  "start_time": 1764055601811,
  "end_time": 1764142001811
}

响应示例

状态码： 200

Success.

{
    "total": 2,
    "fileList": [
        {
            "file_name": "mysql-mysql-bin.045330-mysql-bin.045332-20251126032512000",
            "backup_id": "fa163e0a08a3t11f0ca77849d22e6acacbr01",
            "file_size": 10240,
            "task_info": {
                "id": 1163,
                "gmt_create": 1764141139867,
                "gmt_modified": 1764141140750,
                "tenant_id": "05204146e600d48f0f02c002850ec340",
                "tenant_name": "tenant_name",
                "user_id": "052041480300d4871f02c002ddb097b8",
                "user_name": "user_name",
                "connection_id": "f6ec61f9-24c5-4aaf-b42b-d45d23274031",
                "binlog_type": "backup",
                "file_name": "mysql-mysql-bin.045330-mysql-bin.045332-20251126032512000",
                "backup_id": "fa163e0a08a3t11f0ca77849d22e6acacbr01",
                "status": 3,
                "err_msg": ""
            }
        },
        {
            "file_name": "mysql-mysql-bin.045082-mysql-bin.045087-20251125121021000",
            "backup_id": "fa163e0a08a3t11f0c9f7b6ff3c909c9dbr01",
            "file_size": 10240
        }
    ]
}

状态码

状态码

描述

200

Success.

400

Client error.

500

Server error.

错误码

请参见错误码。

父主题：云DBA

相关文档