Querying Error Logs

Function

This API is used to query the error logs of a specified DB instance. Before calling this API:

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

URI

POST /v3.1/{project_id}/instances/{instance_id}/error-logs

**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	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. If the following response body is returned for calling the API used to obtain a user token, the request is successful. After the request is processed, the value of X-Subject-Token in the message header is the token value.
X-Language	No	String	Request language type. The default value is en-us. Value: en-us zh-cn

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
node_id	Yes	String	Node ID.
start_time	Yes	String	Start time in the "yyyy-mm-ddThh:mm:ssZ" format. 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.
end_time	Yes	String	End time in the "yyyy-mm-ddThh:mm:ssZ" format. 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.
limit	Yes	Integer	Number of records to be queried.
line_num	No	String	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.
level	No	String	Log level. The default value is ALL. Value: ALL INFO LOG WARNING ERROR FATAL PANIC NOTE

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
error_log_list	Array of LtsLogErrorDetail objects	Error logs.

**Table 5** LtsLogErrorDetail
Parameter	Type	Description
node_id	String	Node ID.
time	String	Execution time.
level	String	Log level.
content	String	Error log content.
line_num	String	Sequence number of a log event.

Status code: 400

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 500

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Example Request

Querying error logs

POST https://{endpoint}/v3.1/056538411200d4cd2f79c003c7606412/instances/096c0fc43e804757b59946b80dc27f8bin07/error-logs
{
  "start_time" : "2022-11-20T00:00:00+0800",
  "end_time" : "2022-11-29T00:00:00+0800",
  "node_id" : "cc07c60e94ec4575989840e648fb4f66no07",
  "limit" : 10,
  "line_num" : 1669344916000
}

Example Response

Status code: 200

Success.

{
  "error_log_list" : [ {
    "node_id" : "cc07c60e94ec4575989840e648fb4f66no07",
    "time" : "2022-11-25T10:55:16.000",
    "level" : "ERROR",
    "content" : "[MY013508] [Repl] do failed: 1",
    "line_num" : 1669344916000
  } ]
}