Updated on 2024-09-11 GMT+08:00

Enabling or Disabling Show Original Log

Function

This API is used to enable or disable Show Original Log. Before calling this API:

URI

PUT /v3/{project_id}/instances/{instance_id}/clickhouse/slowlog-sensitive

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.

Request Parameters

Table 2 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
Table 3 Request body parameter

Parameter

Mandatory

Type

Description

open_slow_log_switch

Yes

String

Whether to enable or disable Show Original Log.

Response Parameters

Status code: 200

Table 4 Response body parameter

Parameter

Type

Description

open_slow_log_switch

String

Whether to enable or disable Show Original Log.

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

Disabling Show Original Log

POST https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/86fd60a5256a4592b957e8e6bb2d1b59in07/clickhouse/slowlog-sensitive

{
  "open_slow_log_switch" : "false"
}

Example Response

Status code: 200

Success.

{
  "open_slow_log_switch" : "false"
}

Status Code

Status Code

Description

200

Success.

400

Client error.

500

Server error.

Error Code

For details, see Error Codes.