tencent cloud

APIs

DescribeInstanceSlowQueries

다운로드
포커스 모드
폰트 크기
마지막 업데이트 시간: 2026-06-02 10:38:49

1. API Description

Domain name for API request: cynosdb.intl.tencentcloudapi.com.

This API is used to query the slow log details of an instance. Subject to platform return size limits, return results may be truncated if they are too large.

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: DescribeInstanceSlowQueries.
Version Yes String Common Params. The value used for this API: 2019-01-07.
Region Yes String Common Params. For more information, please see the list of regions supported by the product. This API only supports: ap-bangkok, ap-beijing, ap-chengdu, ap-chongqing, ap-guangzhou, ap-hongkong, ap-jakarta, ap-nanjing, ap-seoul, ap-shanghai, ap-shenzhen-fsi, ap-singapore, ap-tokyo, eu-frankfurt, na-ashburn, na-siliconvalley, sa-saopaulo.
InstanceId Yes String

Instance ID.

StartTime No String

Earliest transaction start time.

EndTime No String

Latest transaction start time.

Limit No Integer

Limit.

It is recommended to control the limit size. Large limits may cause truncation due to the platform's size limit for return results.

Offset No Integer

Offset.

Username No String

Username.

Host No String

Client host.

Database No String

Database name.

OrderBy No String

Sorting field.

Enumeration values:

  • QueryTime: sorts by the total execution time of the SQL statements.
  • LockTime: sorts by the time consumed by the SQL statements waiting for locks (such as table locks or row locks).
  • RowsExamined: sorts by the number of rows scanned during SQL statement execution.
  • RowsSent: sorts by the number of result rows returned to the client for the SQL statements.
  • Timestamp: sorts by the timestamp when the slow query statement occurs.
OrderByType No String

Sorting type. Valid values: asc and desc.

SqlText No String

SQL statement.

3. Output Parameters

Parameter Name Type Description
TotalCount Integer

Total quantity.

SlowQueries Array of SlowQueriesItem

Slow query records.

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 Query Instance Slow Log Details

Input Example

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

{
    "InstanceId": "cynosdbmysql-ins-xxxxxxxx",
    "StartTime": "2022-06-22 00:00:00",
    "EndTime": "2022-06-24 23:59:59"
}

Output Example

{
    "Response": {
        "TotalCount": 1,
        "SlowQueries": [
            {
                "Database": "information_schema",
                "LockTime": 0,
                "QueryTime": 11.00011,
                "RowsExamined": 0,
                "RowsSent": 0,
                "SqlMd5": "267171214708E27C",
                "SqlTemplate": "select sleep(?) limit ? offset ?;",
                "SqlText": "SELECT sleep(11) LIMIT 11 offset 0",
                "Timestamp": 1655891555,
                "UserHost": "11.186.190.10",
                "UserName": "root"
            }
        ],
        "RequestId": "9e56617c-c7cc-44e1-a967-6beb418ad5e7"
    }
}

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
FailedOperation.OperationFailedError Operation failed. Try again later. If the problem persists, contact customer service.
InvalidParameterValue.InvalidParameterValueError Invalid parameter value.
OperationDenied.CamDeniedError Failed to verify permissions
OperationDenied.LengthOverLimit Response size exceeds the limit: {{1}}. reduce the query quantity.
UnauthorizedOperation.PermissionDenied CAM authentication failed.

도움말 및 지원

문제 해결에 도움이 되었나요?

피드백