Release Notes
Announcements
Domain name for API request: mongodb.intl.tencentcloudapi.com.
This API is used to get the slow log information of a TencentDB instance. Only slow logs for the last 7 days can be queried.
A maximum of 20 requests can be initiated per second for this API.
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: DescribeSlowLogs. |
| 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 | Timestamp | Slow log start time. - 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 | Timestamp | Slow log end time. - 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. |
| SlowMS | Yes | Integer | Threshold of slow log execution time in milliseconds. Minimum value: 100. Slow logs whose execution time exceeds the threshold will be returned. |
| Offset | No | Integer | Offset. Minimum value: 0. Maximum value: 10000. Default value: 0. |
| Limit | No | Integer | Number of entries per page. Minimum value: 1. Maximum value: 100. Default value: 20. |
| Format | No | String | Return format of slow log. The original slow log format is returned by default, and the format can be set to JSON on versions 4.4 and later. |
| Parameter Name | Type | Description |
|---|---|---|
| Count | Integer | Total number of slow logs. |
| SlowLogs | Array of String | 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. |
This example shows you how to obtain the slow log information on an instance.
POST / HTTP/1.1
Host: mongodb.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeSlowLogs
<Common request parameters>
{
"InstanceId": "cmgo-r3p8****",
"StartTime": "2025-09-22 00:00:00",
"EndTime": "2025-09-23 00:00:00",
"SlowMS": 100,
"Offset": 1,
"Limit": 1,
"Format": "json"
}{
"Response": {
"Count": 1,
"RequestId": "ec514cb8-55a6-41d4-a6e4-896da43886db",
"SlowLogs": [
"Mon Sep 22 20:30:19.980 I COMMAND [conn3725696] command admin.$cmd command: ****Continue { ****Continue: 1, conversationId: 1, payload: BinData(0, ), $clusterTime: { clusterTime: Timestamp(1758544211, 1), signature: { hash: BinData(0, *************************************), keyId: 7542889************ } }, $db: \"admin\", $readPreference: { mode: \"primaryPreferred\" } } numYields:0 reslen:204 locks:{} protocol:op_msg 184ms"
]
}
}TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
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 |
| InvalidParameter | Parameter error |
| InvalidParameter.PermissionDenied | The current sub-account has no permission to perform this operation. |
| InvalidParameterValue.NotFoundInstance | The instance was not found. |
| InvalidParameterValue.QueryTimeOutOfRange | Only slow logs generated in the past seven days can be queried. |
| 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. |
フィードバック