DescribeDetailedSlowLogs

Last updated:2026-01-13 21:48:11

DescribeDetailedSlowLogs

Last updated: 2026-01-13 21:48:11

1. API Description

Domain name for API request: mongodb.intl.tencentcloudapi.com.

This API is used to query slow log details of the instance.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer

Try it

API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name	Required	Type	Description
Action	Yes	String	Common Params. The value used for this API: DescribeDetailedSlowLogs.
Version	Yes	String	Common Params. The value used for this API: 2019-07-25.
Region	Yes	String	Common Params. For more information, please see the list of regions supported by the product.
InstanceId	Yes	String	Instance ID. Log in to the TencentDB for MongoDB console, and copy the instance ID from the instance list.
StartTime	Yes	String	Specifies the start time for querying slow logs. - Format: yyyy-mm-dd hh:mm:ss. For example, 2019-06-01 10:00:00. - The query start and end time interval cannot exceed 24 hours. Only slow logs within the last 7 days can be queried.
EndTime	Yes	String	Specifies the end time for querying slow logs. - Format: yyyy-mm-dd hh:mm:ss. For example, 2019-06-02 12:00:00. - The query start and end time interval cannot exceed 24 hours. Only slow logs within the last 7 days can be queried.
ExecTime	No	Integer	Specifies the threshold for querying slow logs, in milliseconds. It indicates that the execution time of the slow log query exceeds this value. The default value is 100.
Commands.N	No	Array of String	Specifies the command type for querying slow logs.
Texts.N	No	Array of String	Full-text search keyword. The logical operator among multiple keywords is OR.
NodeNames.N	No	Array of String	Specifies the node name for querying slow logs. The DescribeDBInstanceNodeProperty API can be called to query the node name.
QueryHash.N	No	Array of String	Specifies the queryHash value to be queried.
Offset	No	Integer	Pagination offset. The default value is 0, and the value range is [0, 100].
Limit	No	Integer	Number of returned entries. The default value is 20, and the value range is [0, 10000].
OrderBy	No	String	Specifies the sorting condition for slow logs. - StartTime: sort by the generation time of slow logs. - ExecTime: sort by the execution time of slow logs.
OrderByType	No	String	Specifies the sorting method. - desc: descending order. - asc: ascending order.

3. Output Parameters

Parameter Name	Type	Description
TotalCount	Integer	Number of slow logs that meet the conditions.
DetailedSlowLogs	Array of SlowLogItem	Slow log details.
RequestId	String	The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Querying Slow Log Details

Input Example

POST / HTTP/1.1
Host: mongodb.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeDetailedSlowLogs
<Common request parameters>

{
    "InstanceId": "cmgo-r3p8****",
    "StartTime": "2025-09-22 11:53:15",
    "EndTime": "2025-09-23 11:53:15"
}

Output Example

{
    "Response": {
        "DetailedSlowLogs": [
            {
                "Log": "Mon Sep 22 20:30:19.980 I COMMAND  [conn3725696] command admin.$cmd command: saslContinue { saslContinue: 1, conversationId: 1, payload: BinData(0, ), $clusterTime: { clusterTime: Timestamp(1758544211, 1), signature: { hash: BinData(0, C28B5E1C1EE29**************************), keyId: 75428892796********* } }, $db: \"admin\", $readPreference: { mode: \"primaryPreferred\" } } numYields:0 reslen:204 locks:{} protocol:op_msg 184ms",
                "NodeName": "cmgo-r3p8****_0-node-primary",
                "QueryHash": "admin..****Continue"
            }
        ],
        "RequestId": "5e35a1bd-60e6-4a45-8792-d033581b9209",
        "TotalCount": 1
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

Tencent Cloud CLI 3.0

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code	Description
InternalError	Internal error
InvalidParameterValue.LimitParaOutOfRange	limit value ranges from 1 to 100.
InvalidParameterValue.NotFoundInstance	The instance was not found.
InvalidParameterValue.OffsetParaOutOfRange	offset value ranges from 0 to 10000.
InvalidParameterValue.QueryTimeRangeBeyondLimit	Only slow logs generated in the past seven days can be queried.
InvalidParameterValue.SlowMSBelowLimit	The value range of the slowMS parameter is [100,65536].
InvalidParameterValue.StartTimeNotBeforeThanEndTime	The start time should be earlier than the end time.
InvalidParameterValue.TimeFormatErr	Illegal time format.

Was this page helpful?

You can also Contact Sales or Submit a Ticket for help.

Yes

Feedback

tencent cloud