Help Center/ TaurusDB/ API Reference/ APIs (Recommended)/ HTAP (Standard Edition)/ Creating LTS Configurations in Batches
Updated on 2026-02-11 GMT+08:00

Creating LTS Configurations in Batches

Function

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

Calling Method

For details, see Calling APIs.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see Permissions and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.

URI

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

Table 1 URI parameter

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 contains 32 characters. Only letters and digits are allowed.

Default Value

N/A

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

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.

Constraints

N/A

Range

N/A

Default Value

N/A

X-Language

No

String

Definition

Request language type.

Constraints

N/A

Range

  • en-us

  • zh-cn

Default Value

en-us

Table 3 Request body parameter

Parameter

Mandatory

Type

Description

log_configs

Yes

Array of log_configs objects

Definition

Log configurations.

Constraints

N/A

Table 4 log_configs

Parameter

Mandatory

Type

Description

instance_id

Yes

String

Definition

Standard HTAP instance ID, which uniquely identifies an instance.

Constraints

N/A

Range

The value contains 36 characters with a suffix of in17. Only letters and digits are allowed.

Default Value

N/A

log_type

Yes

String

Definition

Log type.

Constraints

N/A

Range

N/A

Default Value

N/A

lts_group_id

Yes

String

Definition

LTS log group ID.

Constraints

N/A

Range

N/A

Default Value

N/A

lts_stream_id

Yes

String

Definition

LTS log stream ID.

Constraints

N/A

Range

N/A

Default Value

N/A

Response Parameters

Status code: 200

Success

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/starrocks/lts-configs

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

Example Response

Status code: 200

Success

{ }

Status code: 400

Error response

{
  "error_code" : "DBS.200022",
  "error_msg" : "Instance not found."
}

Status Code

For details, see Status Codes.

Error Code

For details, see Error Codes.