Help Center/ TaurusDB/ API Reference/ APIs (Recommended)/ HTAP (Standard Edition)/ Querying LTS Configurations of an Instance

Updated on 2025-09-04 GMT+08:00

Online Debugging

CLI Examples

View PDF

Querying LTS Configurations of an Instance

Function

This API is used to query LTS configurations of an instance. Before calling this API:

Learn how to authorize and authenticate it.
Obtain the required region and endpoint.

URI

GET /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

**Table 2** Query parameters
Parameter	Mandatory	Type	Description
instance_id	No	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
enterprise_project_id	No	String	Definition Enterprise project ID. Constraints N/A Range N/A Default Value N/A
instance_name	No	String	Definition Name of a standard HTAP instance. Constraints N/A Range N/A Default Value N/A
limit	No	Integer	Definition Number of records to be queried. Constraints N/A Range 0–100 Default Value 10
offset	No	Integer	Definition Index offset. If offset is set to N, the resource query starts from the N+1 piece of data. If the value is set to 0, indicating that the query starts from the first piece of data. The value must be a number but cannot be a negative number. Constraints N/A Range 0–10000 Default Value 0

Request Parameters

**Table 3** 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

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
instance_lts_configs	Array of instance_lts_configs objects	Definition LTS configurations of an instance. Constraints N/A
total_count	Integer	Definition Number of instances. Range N/A

**Table 5** instance_lts_configs
Parameter	Type	Description
lts_configs	Array of lts_configs objects	Definition LTS configurations. Constraints N/A
instance	instance object	Definition Information about a standard HTAP instance. Constraints N/A

**Table 6** lts_configs
Parameter	Type	Description
log_type	String	Definition Log type. Range N/A
lts_group_id	String	Definition LTS log group ID. Range N/A
lts_stream_id	String	Definition LTS log stream ID. Range N/A
enabled	String	Definition Whether LTS configurations are enabled. Range N/A

**Table 7** instance
Parameter	Type	Description
id	String	Definition Standard HTAP instance ID, which uniquely identifies an instance. Range The value contains 36 characters with a suffix of in17. Only letters and digits are allowed.
name	String	Definition Name of a standard HTAP instance. Range N/A
engine_name	String	Definition Engine type. Range N/A
engine_version	String	Definition Engine version. Range N/A
status	String	Definition Status of a standard HTAP instance. Range N/A
enterprise_project_id	String	Definition Enterprise project ID. Range N/A
enterprise_project_name	String	Definition Enterprise project name. Range N/A

Status code: 400

**Table 8** Response body parameters
Parameter	Type	Description
error_code	String	Definition Error code. Range N/A
error_msg	String	Definition Error message. Range N/A

Status code: 500

**Table 9** Response body parameters
Parameter	Type	Description
error_code	String	Definition Error code. Range N/A
error_msg	String	Definition Error message. Range N/A

Example Request

Querying LTS configurations of an instance

GET https://{endpoint}/rds/v3/619d3e78f61b4be68bc5aa0b59edcf7b/logs/starrocks/lts-configs?instance_id=faf2cbf7f6cb422d83e61dbcc3e87023in17

Example Response

Status code: 200

Success

{
  "instance_lts_configs" : [ {
    "lts_configs" : [ {
      "log_type" : "error_log",
      "lts_group_id" : "460d8437-9dcb-47d0-8c56-5758f2042272",
      "lts_stream_id" : "bad1ca5d-e347-437f-be89-f2e08ce117b8",
      "enabled" : false
    } ],
    "instance" : {
      "id" : "4c2614fe03ae4ec28184a277b8c00c03in17",
      "name" : "gauss-HTAP",
      "mode" : "Cluster",
      "engine_name" : "starrocks",
      "engine_version" : "2.0.48",
      "status" : "normal",
      "enterprise_project_id" : "0",
      "enterprise_project_name" : "string"
    }
  } ],
  "total_count" : 1
}

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.

Parent topic: HTAP (Standard Edition)

Previous topic: Changing the Security Group of a StarRocks Instance

Next topic: Querying Node Information

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.

Chatbot