Help Center/ TaurusDB/ API Reference/ APIs (Recommended)/ HTAP (Standard Edition)/ Querying Error Logs

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

Online Debugging

CLI Examples

View PDF

Querying Error Logs

Function

This API is used to query error logs of the kernel. Before calling this API:

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

URI

POST /v3/{project_id}/instances/{instance_id}/starrocks/error-logs

**Table 1** URI parameters
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
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

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 parameters
Parameter	Mandatory	Type	Description
node_id	Yes	String	Definition ID of a standard HTAP instance node. Constraints N/A Range N/A Default Value N/A
start_time	Yes	String	Definition Start time of the log. The format is yyyy-mm-ddThh:mm:ssZ. T is the separator between the calendar and the hourly notation of time. Z indicates the time zone offset. For example, if the time zone offset is one hour, the value of Z is +0100. Constraints N/A Range N/A Range N/A
end_time	Yes	String	Definition End time of the log. The format is yyyy-mm-ddThh:mm:ssZ. T is the separator between the calendar and the hourly notation of time. Z indicates the time zone offset. For example, if the time zone offset is one hour, the value of Z is +0100. Constraints N/A Range N/A Default Value N/A
level	Yes	String	Definition Log level. Constraints N/A Range N/A Range N/A
limit	Yes	Integer	Definition Number of records to be queried. Constraints N/A Range 0–100 Default Value N/A
line_num	No	String	Definition Sequence number of a log event. This parameter is not required for the first query, but is required for subsequent pagination queries. The value can be obtained from the response of the last query. Constraints N/A Range N/A Default Value N/A

Response Parameters

Status code: 200

**Table 4** Response body parameter
Parameter	Type	Description
error_log_list	Array of error_log_list objects	Definition Error logs. Constraints N/A

**Table 5** error_log_list
Parameter	Type	Description
node_id	String	Definition ID of a standard HTAP instance node. Range N/A
time	String	Definition Log time. Range N/A
level	String	Definition Log level. Range N/A
content	String	Definition Log content. Range N/A
line_num	String	Definition Sequence number of a log event. This parameter is not required for the first query, but is required for subsequent pagination queries. The value can be obtained from the response of the last query. Range N/A

Status code: 400

**Table 6** 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 7** 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 error logs of the kernel

POST https://{endpoint}/rds/v3/23a50154cf494ec9ad6883979a12db0a/instances/614ff06f72ee46b7949423572dd51e8bin17/starrocks/error-logs

{
  "node_id" : "aeb9e81135b34197bab8636fc8a1c569no17",
  "start_time" : "2025-05-12T00:14:27+0100",
  "end_time" : "2025-05-12T02:14:27+0100",
  "limit" : "10",
  "line_num" : "1669344916000",
  "level" : "All"
}

Example Response

Status code: 200

Success

{
  "error_log_list" : [ {
    "node_id" : "941d21130b3c4899ad1a752a0945befdno07",
    "time" : "2025-04-24T03:25:19",
    "level" : "WARNING",
    "content" : "[MY-012091] [InnoDB] Allocated tablespace ID 6 for mysql/node_host_status, old maximum was 4",
    "line_num" : "1669344916000"
  } ]
}

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: Querying Databases of a Primary HTAP Instance

Next topic: Changing the Security Group of a StarRocks Instance

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