Help Center/ Data Admin Service/ API Reference/ APIs/ Intelligent O&M/ Stopping a Binlog Parsing Task
Updated on 2026-08-25 GMT+08:00

Stopping a Binlog Parsing Task

Function

This API is used to stop 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

    -

    -

    -

URI

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

Table 1 URI parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID of a tenant in a region.

To obtain the 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

task_id

Yes

Long

Definition

ID of a parsing task

Constraints

N/A

Range

N/A

Default Value

N/A

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

success

Boolean

Definition

Whether the request is successful

Range

N/A

status

Integer

Definition

Status

Range

  • 1: successful
  • 2: failed

error_msg

String

Definition

Error message, which is displayed only when the status is 2.

Range

N/A

Example Requests

POST https://das.cn-north-1.myhuaweicloud.com/v3/054e292c9880d4992f02c0196d3ea468/connections/179e525e-0e9c-4dcc-9dd7-ee2f36121e23/binlog-parse/stop-task

 { "task_id": 1234 }

Example Responses

Status code: 200

Success.

{ "success": true, "status": 1, "error_msg": "" }

Status Codes

Status Code

Description

200

Success.

400

Client error.

500

Server error.

Error Codes

See Error Codes.