Querying Binlog Files

Function

This API is used to query binlog files.

Authorization Information

Each account has permissions to call all APIs, but IAM users must have the required permissions specifically assigned.

If you are using role/policy-based authorization, see the required permissions in Permissions Policies and Supported Actions.
If you are using identity policy-based authorization, the following identity policy-based permissions are required.

Action

Access Level

Resource Type (*: required)

Condition Key

Alias

Dependencies

das:clouddba:listBinlog

List

Instance

-

-

-

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
das:clouddba:listBinlog	List	Instance	-	-	-

URI

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

**Table 1** URI parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID. Constraints N/A Range The value can contain 32 characters. Only letters and digits are supported. Default Value N/A
connection_id	Yes	String	Definition Connection ID established between a database account and the database. The database user ID is created using the API in Creating an Instance Connection. Constraints N/A Range The value is a UUID containing 36 characters. Only letters, digits, and hyphens (-) are allowed. Default Value N/A

Request Parameters

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
binlog_type	Yes	String	Definition Binlog file type Constraints N/A Range latest: latest logs backup: archive logs Default Value N/A
start_time	No	Long	Definition Start time in the Unix timestamp format, in milliseconds Constraints N/A Range [0, 2^63 – 1]. The actual value depends on the query result. Default Value N/A
end_time	No	Long	Definition End time in the Unix timestamp format, in milliseconds Constraints N/A Range [0, 2^63 – 1]. The actual value depends on the query result. Default Value N/A
cur_page	No	Integer	Definition Number of records on each page Constraints N/A Range [0, 100]. The actual value depends on the query result. Default Value N/A
per_page	No	Integer	Definition Page number Constraints N/A Range [0, 2^31 – 1]. The actual value depends on the query result. Default Value N/A

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
total	Integer	Definition Total number Range [0, 2^31-1]
file_list	Array of Table 4 objects	Definition Binlog files

**Table 4** BinlogFileInfo
Parameter	Type	Description
file_name	String	Definition File name Range N/A
backup_id	String	Definition Backup ID Range N/A
file_size	Long	Definition File size Range N/A
task_info	BinlogParseTaskInfo object	Definition Archive log parsing information Range N/A
begin_time	String	Definition Start time of binlog backup. Range N/A
end_time	String	Definition End time of binlog backup. Range N/A

**Table 5** BinlogParseTaskInfo
Parameter	Type	Description
id	Long	Definition Task ID Range [0, 2^31-1]
gmt_create	Long	Definition Creation time of a task, in milliseconds Range N/A
gmt_modified	Long	Definition Modification time of a task, in milliseconds Range N/A
tenant_id	String	Definition Tenant ID Range N/A
tenant_name	String	Definition Tenant name Range N/A
user_id	String	Definition User ID Range N/A
user_name	String	Definition Username Range N/A
connection_id	String	Definition Connection ID established between a database account and the database. The database user ID is created using the API for creating an instance connection. Range The value is a UUID containing 36 characters. Only letters, digits, and hyphens (-) are allowed.
binlog_type	String	Definition Binlog type Range latest: latest logs backup: archive logs
file_name	String	Definition Name of a binlog file Range N/A
backup_id	String	Definition Backup file ID Range N/A
status	Integer	Definition Task status Range 0: initializing 1: running 2: partially successful 3: successful 4: failed -1: deleted
err_msg	String	Definition Error message Range N/A

Example Requests

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
}

Example Responses

Status code: 200

Success.

{
    "total": 2,
    "file_list": [
        {
            "file_name": "mysql-mysql-bin.045330-mysql-bin.045332-20251126032512000",
            "backup_id": "fa163e0a08a3t11f0ca77849d22e6acacbr01",
            "file_size": 10240,
            "begin_time": "2026-06-30T12:21:02+0000",
            "end_time": "2026-06-30T12:26:02+0000",
            "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,
            "begin_time": "2026-06-30T12:16:02+0000",
            "end_time": "2026-06-30T12:21:02+0000"
        }
    ]
}

Status Codes

Status Code	Description
200	Success.
400	Client error.
500	Server error.

Error Codes

See Error Codes.

Parent topic: Intelligent O&M

Previous topic: Viewing Details About a Binlog Parsing Task

Next topic: Retrying a Binlog Parsing Task