tencent cloud

All product documents
APIs
DocumentationAPIsTencentDB for DBbrainDBbrain APIs 2019-10-16Slow Log Analysis APIsDescribeSlowLogTopSqls
DescribeSlowLogTopSqls
Last updated: 2024-11-19 21:55:17
DescribeSlowLogTopSqls
Last updated: 2024-11-19 21:55:17

1. API Description

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

This API is used to get and sort the top slow SQL statements in a specified time period by the aggregation mode of SQL template plus schema.

A maximum of 5 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: DescribeSlowLogTopSqls.
Version Yes String Common Params. The value used for this API: 2019-10-16.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
InstanceId Yes String Instance ID.
StartTime Yes Timestamp Start time, such as "2019-09-10 12:13:14".
EndTime Yes Timestamp End time, such as "2019-09-10 12:13:14". The interval between the end time and the start time can be up to 7 days.
SortBy No String Sorting key. Valid values: QueryTime, ExecTimes, RowsSent, LockTime, RowsExamined.
OrderBy No String Sorting order. Valid values: ASC (ascending), DESC (descending).
Limit No Integer Number of results to be returned. Default value: 20. Maximum value: 100.
Offset No Integer Offset. Default value: 0.
SchemaList.N No Array of SchemaItem Database name array.
Product No String Service type. Valid values: mysql (TencentDB for MySQL), cynosdb (TencentDB for CynosDB (compatible with MySQL)). Default value: mysql.

3. Output Parameters

Parameter Name Type Description
TotalCount Integer Number of eligible entries.
Rows Array of SlowLogTopSqlItem List of top slow SQL statements
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 statistics during a specified time period by SQL template

Input Example

https://dbbrain.intl.tencentcloudapi.com/?Action=DescribeSlowLogTopSqls
&InstanceId=test
&SortBy=QueryTime
&OrderBy=ASC
&Limit=10
&Offset=0
&StartTime=2019-01-01 00:00:00
&EndTime=2019-01-01 01:00:00
&SchemaList.0.Schema=dbName
&<common request parameters>

Output Example

{
    "Response": {
        "RequestId": "",
        "TotalCount": 1,
        "Rows": [
            {
                "RowsExaminedMax": 0,
                "ExecTimes": 2,
                "RowsSentMax": 0,
                "QueryTimeRatio": 100,
                "LockTimeRatio": 0,
                "LockTimeMin": 0,
                "RowsExaminedRatio": 0,
                "Schema": "dbName",
                "SqlText": "select test from test",
                "QueryTime": 28.17341,
                "SqlTemplate": "select ? from ?",
                "QueryTimeMax": 14.086705,
                "LockTime": 0,
                "RowsSent": 0,
                "RowsSentMin": 0,
                "LockTimeMax": 0,
                "RowsSentRatio": 0,
                "RowsExamined": 0,
                "RowsExaminedMin": 0,
                "QueryTimeMin": 0
            }
        ]
    }
}

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

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
FailedOperation Operation failed.
InvalidParameter Incorrect parameter.
InvalidParameterValue Incorrect parameter value.
LimitExceeded The quota limit is exceeded.
OperationDenied.UserHasNoStrategy Error with CAM authentication.
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback

Contact Us

Contact our sales team or business advisors to help your business.

Contact Us
Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

Submit a Ticket
7x24 Phone Support
Hong Kong, China
+852 800 906 020 (Toll Free)
United States
+1 844 606 0804 (Toll Free)
United Kingdom
+44 808 196 4551 (Toll Free)
Canada
+1 888 605 7930 (Toll Free)
Australia
+61 1300 986 386 (Toll Free)
EdgeOne hotline
+852 300 80699
More local hotlines coming soon