DescribeSlowLogPatterns

Last updated: 2020-07-31 11:03:12

1. API Description

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

This API is used to get the slow log statistics of a database instance.

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

Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: mongodb.ap-shanghai-fsi.tencentcloudapi.com

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 parameter. The value used for this API: DescribeSlowLogPatterns.
Version Yes String Common parameter. The value used for this API: 2019-07-25.
Region Yes String Common parameter. For more information, please see the list of regions supported by the product.
InstanceId Yes String Instance ID in the format of cmgo-p8vnipr5, which is the same as the instance ID displayed on the TencentDB Console page
StartTime Yes Timestamp Start time of slow log in the format of yyyy-mm-dd hh:mm:ss, such as 2019-06-01 10:00:00. The query time range cannot exceed 24 hours. Only slow logs for the last 7 days can be queried.
EndTime Yes Timestamp End time of slow log in the format of yyyy-mm-dd hh:mm:ss, such as 2019-06-02 12:00:00. The query time range cannot exceed 24 hours. Only slow logs for 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.

3. Output Parameters

Parameter Name Type Description
Count Integer Total number of slow logs
SlowLogPatterns Array of SlowLogPattern Slow log statistics
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Querying the slow log statistics of a database

Input Example

https://mongodb.tencentcloudapi.com/?Action=DescribeSlowLogPatterns
&InstanceId=cmgo-a3bm93hf
&StartTime=2020-04-20 00:00:00
&EndTime=2020-04-20 22:00:00
&SlowMS=100
&Offset=0
&Limit=100
&<common request parameters>

Output Example

{
  "Response": {
    "Count": 2,
    "RequestId": "895de939-f726-4cb0-bb02-3890289479e3",
    "SlowLogPatterns": [
      {
        "AverageTime": 699,
        "MaxTime": 5335,
        "Pattern": "admin.$cmd.command",
        "Total": 12
      },
      {
        "AverageTime": 271,
        "MaxTime": 423,
        "Pattern": "local.system.replset.command",
        "Total": 8
      }
    ]
  }
}

5. Developer Resources

API Explorer

This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.

SDK

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

Command Line Interface

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.
InvalidParameter Invalid parameter.
InvalidParameterValue.NotFoundInstance The instance was not found.
InvalidParameterValue.QueryTimeOutOfRange Only slow logs in the past 7 days can be queried.
InvalidParameterValue.QueryTimeRangeBeyondLimit Only slow logs in the past 7 days can be queried.

Was this page helpful?

Was this page helpful?

  • Not at all
  • Not very helpful
  • Somewhat helpful
  • Very helpful
  • Extremely helpful
Send Feedback
Help