Querying Database Error Logs¶
Function¶
This API is used to query database error logs.
Constraints¶
A maximum of 2000 records can be queried within the period specified by start_date and end_date.
URI¶
URI format
GET https://{Endpoint}/v3/{project_id}/instances/{instance_id}/errorlog?offset={offset}&limit={limit}&start_date={start_date}&end_date={end_date}&type={type}&node_id={node_id}
Parameter description
Table 1 Parameter description¶ Name
Mandatory
Description
project_id
Yes
Specifies the project ID of a tenant in a region.
instance_id
Yes
Specifies the instance ID, which can be obtained by calling the API for querying instances. If you do not have an instance, you can call the API used for creating an instance.
start_date
Yes
Specifies the 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.
Caution
CAUTION: The start time is 31 days earlier than the current time.
end_date
Yes
Specifies the 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.
Only error logs generated within the last month can be queried.
Note
The end time cannot be later than the current time.
node_id
No
Specifies the node ID. For details, see Table 8.
If this parameter is left blank, all nodes in the instance can be queried.
Nodes that can be queried:
mongos, shard, and config nodes in a cluster instance.
All nodes in a replica set or single node instance.
type
No
Specifies the statement type. If it is left blank, all statement types are queried. Valid value:
WARNING
ERROR
offset
No
Specifies the index position. Its value range is [0, 1999].
If offset is set to N, the resource query starts from the N+1 piece of data. The value is 0 by default, indicating that the query starts from the first piece of data. The value cannot be a negative number.
limit
No
Specifies the number of resources to be queried. The value ranges from 1 to 100. The default value is 10, indicating that 10 records are returned by default.
Note
The sum of limit and offset values must be less than or equal to 2000.
Requests¶
Example request
Querying database error logs.
Querying database error logs based on specified conditions.
Responses¶
Parameter description
Table 2 Parameter description¶ Name
Type
Description
error_log_list
Array of objects
Indicates detailed information.
For details, see Table 3.
total_record
Integer
Indicates the total number of records.
Table 3 error_log_list field data structure description¶ Name
Type
Description
node_name
String
Indicates the node name.
level
String
Indicates the log level.
time
String
Indicates the time in the UTC format.
content
String
Indicates the log content.
Response example
{ "error_log_list": [ { "node_name": "Test_replica_node_2", "level": "WARNING", "time": "2020-12-15T08:53:01.868+0000", "content": "W NETWORK [LogicalSessionCacheReap] Unable to reach primary for set replica" } ], "total_record": 1 }
Status Code¶
Status Code:200.
For more information, see Status Code.
Error Code¶
For more information, see Error Code.