tencent cloud

All product documents
Tencent Cloud TCHouse-D
DocumentationTencent Cloud TCHouse-DAPI DocumentationDatabase and Operation Audit APIsDescribeSlowQueryRecords
DescribeSlowQueryRecords
Download PDF
Last updated: 2024-09-12 11:47:43
DescribeSlowQueryRecords
Last updated: 2024-09-12 11:47:43
Download PDF

1. API Description

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

This API is used to get the slow log list.

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: DescribeSlowQueryRecords.
Version Yes String Common Params. The value used for this API: 2021-12-28.
Region No String Common Params. This parameter is not required for this API.
InstanceId Yes String Instance ID
QueryDurationMs Yes Integer Slow log time
StartTime Yes String Start time
EndTime Yes String End time
PageSize Yes Integer Paging
PageNum Yes Integer Paging
DurationMs No String Sort parameters
DbName.N No Array of String Database name
IsQuery No Integer Whether it is a query. 0 indicates no, and 1 indicates yes.
CatalogName.N No Array of String catalog name
Sql No String SQL name
ReadRows No String ReadRows sort field
ResultBytes No String ResultBytes sort field
MemoryUsage No String MemoryUsage sort field

3. Output Parameters

Parameter Name Type Description
TotalCount Integer Total
SlowQueryRecords Array of SlowQueryRecord Record list
DBNameList Array of String All database names
Note: This field may return null, indicating that no valid values can be obtained.
CatalogNameList Array of String All catalog names
Note: This field may return null, indicating that no valid values can be obtained.
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 DescribeSlowQueryRecords

This example shows you the slow log.

Input Example

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

{
    "InstanceId": "abc",
    "QueryDurationMs": 0,
    "StartTime": "abc",
    "EndTime": "abc",
    "PageSize": 0,
    "PageNum": 0,
    "DurationMs": "abc"
}

Output Example

{
    "Response": {
        "TotalCount": 0,
        "SlowQueryRecords": [
            {
                "OsUser": "abc",
                "InitialQueryId": "abc",
                "Sql": "abc",
                "QueryStartTime": "abc",
                "DurationMs": 0,
                "ReadRows": 0,
                "ResultRows": 0,
                "ResultBytes": 1,
                "MemoryUsage": 0,
                "InitialAddress": "abc"
            }
        ],
        "RequestId": "abc"
    }
}

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

There is no error code related to the API business logic. For other error codes, please see Common Error Codes.

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