Help Center/ GaussDB(for MySQL)/ API Reference/ APIs (Recommended)/ HTAP (Lightweight Edition)/ Stopping Modifying Data Synchronization Configurations
Updated on 2024-09-11 GMT+08:00

Stopping Modifying Data Synchronization Configurations

Function

This API is used to stop modifying data synchronization configurations. Before calling this API:

URI

DELETE /v3/{project_id}/instances/{instance_id}/clickhouse/databases/replication/config

Table 1 URI parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID of a tenant in a region.

To obtain this value, see Obtaining a Project ID.

instance_id

Yes

String

ClickHouse instance ID, which is compliant with the UUID format.

Table 2 Query parameter

Parameter

Mandatory

Type

Description

database

Yes

String

Database name.

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token.

To obtain this value, call the IAM API for obtaining a user token.

The value of X-Subject-Token in the response header is the token value.

X-Language

No

String

Request language type. The default value is en-us.

Values:

  • en-us
  • zh-cn

Response Parameters

Status code: 200

Table 4 Response body parameter

Parameter

Type

Description

job_id

String

ID of the created task.

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 500

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Request

Stopping modifying data synchronization configurations

DELETE https://{endpoint}/v3/23a50154cf494ec9ad6883979a12db0a/instances/5eee1a10401b451eb7e6d3badc9c5b95in16/clickhouse/databases/replication/config?database=db

Example Response

Status code: 200

Success.

{
  "job_id" : "3077fd46-2924-4513-ae07-82bac7886a9c"
}

Status Code

Status Code

Description

200

Success.

400

Client error.

500

Server error.

Error Code

For details, see Error Codes.