tencent cloud

DescribeSlowLogs
Download PDF
Last updated: 2023-10-17 10:51:53
DescribeSlowLogs
Last updated: 2023-10-17 10:51:53
Download PDF

1. API Description

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

This API is used to obtain the slow log details of a SQL template in a specified time period.

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: DescribeSlowLogs.
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.
Product Yes String Service type. Valid values: mysql (TencentDB for MySQL), cynosdb (TDSQL-C for MySQL). Default value: mysql.
InstanceId Yes String Instance ID
Md5 Yes String MD5 value of a SQL template
StartTime Yes Timestamp ISO8601 Start time in the format of "2019-09-10 12:13:14".
EndTime Yes Timestamp ISO8601 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.
Offset Yes Integer The offset. Default value: 0.
Limit Yes Integer The number of queried items. Default value: 20. Max value: 100.
DB.N No Array of String Database list
Key.N No Array of String Keyword
User.N No Array of String User
Ip.N No Array of String IP
Time.N No Array of Integer Duration range. The left and right borders of the range are the zeroth and first element of the array, respectively.

3. Output Parameters

Parameter Name Type Description
TotalCount Integer Number of eligible entries.
Rows Array of SlowLogInfoItem Slow log details
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 details in a specified time period by SQL template

This example shows you how to query slow log details in a specified time period by SQL template.

Input Example

https://dbbrain.tencentcloudapi.com/?Action= DescribeSlowLogs
&Product=mysql
&InstanceId=test
&Md5=12323242323
&Limit=10
&Offset=0
&StartTime=2020-09-22T00:00:00+00:00
&EndTime=2020-09-22T00:00:00+00:00
&<Common request parameters>

Output Example

{
    "Response": {
        "TotalCount": 2,
        "RequestId": "ea7afb20-cf8d-11ed-9231-5be1865f5f0a",
        "Rows": [
            {
                "LockTime": 0,
                "UserHost": "169.254.128.9",
                "RowsSent": 1,
                "UserName": "root",
                "Database": "information_schema",
                "SqlText": "/* dbbrain user mark */select SLEEP(10)",
                "QueryTime": 10,
                "RowsExamined": 0,
                "Timestamp": "2023-03-31 10:47:35"
            },
            {
                "LockTime": 0,
                "UserHost": "169.254.128.9",
                "RowsSent": 1,
                "UserName": "root",
                "Database": "information_schema",
                "SqlText": "/* dbbrain user mark */select SLEEP(8)",
                "QueryTime": 8,
                "RowsExamined": 0,
                "Timestamp": "2023-03-31 10:47:45"
            }
        ]
    }
}

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.
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.
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback