tencent cloud

TencentDB for DBbrain

Release Notes and Announcements
Release Notes
Announcements
Product Introduction
Overview
Features
Strengths
Use Cases
Feature List
Region List
Purchase Guide
Operation Guide
Cloud Access Management
Self-Built Database Access
Instance Overview
Instance Management
Monitoring and Alarms
Health Report and Kill Session Report Management
MySQL/TDSQL-C for MySQL Performance Optimization
TDSQL for MySQL/MariaDB Performance Optimization
Distributed cache database (Distributed Cache) diagnostic optimization
MongoDB Performance Optimization
Full-Link Analysis
Practical Tutorial
Fixing High CPU Utilization on MySQL Instance
Fixing Lock Conflict on MySQL Instance
How to Address High CPU Utilization Issues in Distributed Cache Instances
Fixing High CPU Utilization in MongoDB Instance
Fixing Short Node Oplog Retention Period in MongoDB Instance
API Documentation
History
Introduction
Introduction
API Category
Making API Requests
Session Killing APIs
Exception Detection APIs
Other APIs
Redis related APIs
Health Report Email Sending APIs
Space Analysis APIs
Slow Log Analysis APIs
Security Audit APIs
Database Audit APIs
Data Types
Error Codes
DBbrain APIs 2019-10-16
FAQs
Self-Built Database Issues
MySQL Performance
Product
Service Level Agreement
Glossary
Contact Us

DescribeSlowLogTopSqls

PDF
Modo Foco
Tamanho da Fonte
Última atualização: 2025-10-24 14:50:40

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 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: DescribeSlowLogTopSqls.
Version Yes String Common Params. The value used for this API: 2021-05-27.
Region No String Common Params. This parameter is not required for this API.
InstanceId Yes String Instance ID.
StartTime Yes Timestamp Start time, such as "2019-09-10 12:13:14".
EndTime Yes Timestamp End time in the format of "2019-09-11 10: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. Default value: QueryTime.
OrderBy No String Sorting order. Valid values: ASC (ascending), DESC (descending). Default value: DESC.
Limit No Integer Number of returned results. 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 (TDSQL-C for 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, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Obtaining the list of slow SQL templates

This example shows you how to obtain and sort the top slow SQL statements in a specified time period by the aggregation mode of SQL template plus schema.

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": "ed279d8b-a9d9-48d6-9429-e0fde000994a",
        "TotalCount": 1,
        "Rows": [
            {
                "QueryTimeMin": 0.0,
                "LockTimeMin": 0.0,
                "QueryTimeMax": 14.086705,
                "QueryTimeRatio": 0.0,
                "RowsSentRatio": 0.0,
                "RowsSentMax": 0,
                "RowsExaminedMin": 0,
                "RowsSentMin": 0,
                "SqlText": "select * from user where name='sz'",
                "Schema": "test",
                "LockTimeMax": 0.0,
                "LockTimeRatio": 0.0,
                "ExecTimes": 2,
                "LockTimeAvg": 0.0,
                "RowsExamined": 0,
                "RowsSentAvg": 0.0,
                "QueryTime": 28.17341,
                "RowsExaminedAvg": 0.0,
                "RowsExaminedMax": 0,
                "RowsSent": 0,
                "RowsExaminedRatio": 0.0,
                "QueryTimeAvg": 0.0,
                "SqlTemplate": "select * from user where name=?",
                "LockTime": 0.0,
                "Md5": "2323847233"
            }
        ]
    }
}

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
AuthFailure Error with CAM signature/authentication.
FailedOperation Operation failed.
FailedOperation.SegmentLoading Loading data
InternalError Internal error.
InvalidParameter Incorrect parameter.
InvalidParameterValue Incorrect parameter value.
LimitExceeded The quota limit is exceeded.
MissingParameter Missing parameter.
OperationDenied Operation denied.
OperationDenied.UserHasNoStrategy Error with CAM authentication.
ResourceNotFound The resource does not exist.
UnauthorizedOperation The operation is unauthorized.
UnknownParameter Unknown parameter.
UnsupportedOperation Unsupported operation.

Ajuda e Suporte

Esta página foi útil?

comentários