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

Creating LTS Configurations in Batches

Function

This API is used to create LTS configurations in batches. Before calling this API:

URI

POST /v3/{project_id}/clickhouse/instances/logs/lts-configs

Table 1 URI parameter

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.

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

log_configs

Yes

Array of log_configs objects

Log configurations.

Table 4 log_configs

Parameter

Mandatory

Type

Description

instance_id

Yes

String

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

log_type

Yes

String

Log type. Only slow_log is supported.

lts_group_id

Yes

String

LTS log group ID.

lts_stream_id

Yes

String

LTS log stream ID.

Response Parameters

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

Creating LTS configurations in batches

POST https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/logs/clickhouse/lts-configs

{
  "log_configs" : [ {
    "instance_id" : "86fd60a5256a4592b957e8e6bb2d1b59in07",
    "log_type" : "slow_log",
    "lts_group_id" : "460d8437-9dcb-47d0-8c56-5758f2042272",
    "lts_stream_id" : "bad1ca5d-e347-437f-be89-f2e08ce117b8"
  } ]
}

Example Response

None

Status Code

Status Code

Description

200

Success.

400

Client error.

500

Server error.

Error Code

For details, see Error Codes.