tencent cloud

All product documents
APIs
DocumentationAPIsTDSQL for MySQLTDSQL APIsDescribeDBSlowLogs
DescribeDBSlowLogs
Last updated: 2024-07-19 14:30:37
DescribeDBSlowLogs
Last updated: 2024-07-19 14:30:37

1. API Description

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

This API is used to query the list of slow query logs.

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: DescribeDBSlowLogs.
Version Yes String Common Params. The value used for this API: 2018-04-11.
Region No String Common Params. This parameter is not required for this API.
InstanceId Yes String Instance ID in the format of dcdbt-hw0qj6m1
Offset Yes Integer Data entry number starting from which to return results
Limit Yes Integer Number of results to be returned
StartTime Yes Timestamp Query start time in the format of 2016-07-23 14:55:20
ShardId Yes String Shard ID of the instance in the format of shard-53ima8ln
EndTime No Timestamp Query end time in the format of 2016-08-22 14:55:20. If this parameter is left empty, the current time will be used as the query end time.
Db No String Specific name of the database to be queried
OrderBy No String Sorting metric. Valid values: query_time_sum, query_count. Default value: query_time_sum
OrderByType No String Sorting order. Valid values: desc (descending), asc (ascending). Default value: desc
Slave No Integer Query slow queries from either the source or the replica. Valid values: 0 (source), 1 (replica). Default value: 0

3. Output Parameters

Parameter Name Type Description
LockTimeSum Float Sum of all statement lock durations
QueryCount Integer Total number of statement queries
Total Integer Total number of results
QueryTimeSum Float Sum of all statement query durations
Data Array of SlowLogData Slow query log data
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 None

Input Example

POST / HTTP/1.1
Host: dcdb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeDBSlowLogs
<Common request parameters>

{
    "ShardId": "shard-ngbrea6b",
    "InstanceId": "dcdbt-21dfpcv1",
    "Limit": "10",
    "StartTime": "2022-03-22 00:00:00",
    "Offset": "0"
}

Output Example

{
    "Response": {
        "Data": [],
        "LockTimeSum": 0,
        "QueryCount": 0,
        "QueryTimeSum": 0,
        "RequestId": "6e9bf5de-8d17-4848-915d-aee0047909eb",
        "Total": 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
InternalError.DbOperationFailed Failed to query the database.
InternalError.GetInstanceInfoFailed Failed to get the instance information.
InternalError.GetSlowLogFailed Failed to query slow query logs.
InternalError.InnerSystemError Internal system error.
InvalidParameter.IllegalTime Incorrect time parameter.
ResourceUnavailable.InstanceAlreadyDeleted The database instance has been dropped.
ResourceUnavailable.InstanceStatusAbnormal Incorrect database instance status. Operations are not allowed.
UnauthorizedOperation.PermissionDenied You have no permission to manipulate this API or resource.
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 available.

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