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

Creating a Binlog Parsing Task

Function

This API is used to create a binlog parsing task.

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:createBinlogAnalysisTask

Write

Instance

-

-

-

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

URI

POST /v3/{project_id}/connections/{connection_id}/binlog-parse/create-task

**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 type Constraints N/A Range latest: latest logs backup: archive logs fragment: fragment backup logs Default Value N/A
file_name	Yes	String	Definition Name of a binlog file Constraints N/A Range N/A Default Value N/A
backup_id	No	String	Definition Archive ID Constraints N/A Range N/A Default Value N/A

Response Parameters

Status code: 200

**Table 3** Response body parameters
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

Example Requests

POST https://das.cn-north-1.myhuaweicloud.com/connections/179e525e-0e9c-4dcc-9dd7-ee2f36121e23/binlog-parse/create-task
 
{
  "binlog_type": "backup",
  "file_name": "mysql-mysql-bin.044348-mysql-bin.044349-20251122091153000",
  "backup_id": "fa163e0a08a3t11f0c783496bc7e6803abr01"
}

Example Responses

Status code: 200

Success.

{
    "id": 1161,
    "gmt_create": 1763888353776,
    "gmt_modified": 1763888353776,
    "tenant_id": "05204146e600d48f0f02c002850ec340",
    "tenant_name": "user_name",
    "user_id": "c8d72a9c2dd94e4da820784302d17df2",
    "user_name": "user_name",
    "connection_id": "47a997c7-f44d-4937-9602-b358cf5141ec",
    "binlog_type": "backup",
    "file_name": "mysql-mysql-bin.044348-mysql-bin.044349-20251122091153000",
    "backup_id": "fa163e0a08a3t11f0c783496bc7e6803abr01",
    "status": 0
}

Status Codes

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

Error Codes

See Error Codes.

Parent topic: Intelligent O&M