Updated on 2026-08-25 GMT+08:00

Viewing the Binlog Overview

Function

This API is used to view the binlog overview.

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/show

**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
file_name	Yes	String	Definition Name of a binlog file Constraints N/A Range N/A Default Value N/A
cur_page	No	Integer	Definition Current page. Constraints N/A Range N/A Default Value N/A
per_page	No	Integer	Definition Page size. Constraints N/A Range N/A Default Value N/A

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
event_list	Array of Table 4 objects	Definition Binlog event overview

**Table 4** EventEventsDto
Parameter	Type	Description
log_name	String	Definition File name Range N/A
pos	Long	Definition Position Range N/A
event_type	String	Definition Event type Range N/A
server_id	String	Definition Server ID Range N/A
end_log_pos	Long	Definition End position Range N/A
info	String	Definition Information Range N/A

Example Requests

POST https://das.cn-north-1.myhuaweicloud.com/v3/054e292c9880d4992f02c0196d3ea468/connections/179e525e-0e9c-4dcc-9dd7-ee2f36121e23/binlog-parse/show
 
{ 
    "file_name": "mysql-bin.045372",
    "cur_page": 1,
    "per_page": 10
 }

Example Responses

Status code: 200

Success.

{
    "event_list": [
        {
            "log_name": "mysql-bin.045372",
            "pos": 4,
            "event_type": "Format_desc",
            "server_id": "1743236903",
            "end_log_pos": 126,
            "info": "Server ver: 5.7.44-241205-log, Binlog ver: 4"
        },
        {
            "log_name": "mysql-bin.045372",
            "pos": 126,
            "event_type": "Previous_gtids",
            "server_id": "1743236903",
            "end_log_pos": 237,
            "info": "18927aa2-a399-11ee-ab01-fa163e0a08a3:1-35976,\n1d6d380e-a399-11ee-b376-fa163e0a1630:1-13581892"
        },
        {
            "log_name": "mysql-bin.045372",
            "pos": 237,
            "event_type": "Rotate",
            "server_id": "1743236903",
            "end_log_pos": 284,
            "info": "mysql-bin.045373;pos=4"
        }
    ]
}

Status Codes

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

Error Codes

See Error Codes.

Parent topic: Intelligent O&M