DescribeSlowLogTopSqls

Prev Next

search by keyword

Recent Pages

Documentation

Download PDF

Last updated: 2022-01-06 14:27:49

Download PDF

1. API Description

Domain name for API request: dbbrain.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 parameter. The value used for this API: DescribeSlowLogTopSqls.
Version	Yes	String	Common parameter. The value used for this API: 2021-05-27.
Region	Yes	String	Common parameter. 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 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 Querying slow log statistics in specified time period by SQL template

Input Example

https://dbbrain.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": "xx",
        "Schema": "xx",
        "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": "xx",
        "LockTime": 0.0,
        "Md5": "xx"
      }
    ]
  }
}

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
AuthFailure	Error with CAM signature/authentication.
FailedOperation	Operation failed.
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.

Recent Pages