tencent cloud

Feedback

DescribeSlowLog

Last updated: 2022-10-13 14:35:25

1. API Description

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

This API is used to query the records of slow query.

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: DescribeSlowLog.
Version Yes String Common Params. The value used for this API: 2018-04-12.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
InstanceId Yes String Instance ID
BeginTime Yes String The start time
EndTime Yes String The end time
MinQueryTime No Integer The average execution time threshold of slow query in microseconds
Limit No Integer Number of slow queries displayed per page. Default value: 20.
Offset No Integer Slow query offset, which is an integral multiple of Limit.
Role No String Node role.
  • Master: Master node
  • Slave: Replica node

3. Output Parameters

Parameter Name Type Description
TotalCount Integer Total number of slow queries
InstanceSlowlogDetail Array of InstanceSlowlogDetail Slow query details
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Sample request

Input Example

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

{
    "InstanceId": "crs-asdasdas",
    "EndTime": "2019-09-09 12:12:41",
    "BeginTime": "2019-09-08 12:12:41"
}

Output Example

{
    "Response": {
        "InstanceSlowlogDetail": [
            {
                "Node": "833a2f6d8b402319aee8ad7f1c0fbbf7a6604337",
                "Command": "hget",
                "CommandLine": "hget hash_key classify_scope::default",
                "Duration": 45,
                "ExecuteTime": "2019-09-08 12:13:08",
                "Client": ""
            },
            {
                "Node": "833a2f6d8b402319aee8ad7f1c0fbbf7a6604337",
                "Command": "keys",
                "CommandLine": "keys OtherResControler:orion.ovs.client.1514259512471:orion.ovs.entprise.9281083591:sence:*",
                "Duration": 41,
                "ExecuteTime": "2019-09-08 12:13:08",
                "Client": ""
            },
            {
                "Node": "24a05f0d545da235f07a5bc5deebb937af8f721e",
                "Command": "get",
                "CommandLine": "get slot::fsm::status::orion.ovs.client.1508751991541::1db7ffcf9216bc1fd939e6c710514f6fb40fd4fe1525f",
                "Duration": 41,
                "ExecuteTime": "2019-09-08 12:13:08",
                "Client": ""
            }
        ],
        "RequestId": "121d5b40-d2b8-11e9-8c40-ef686158cbd6",
        "TotalCount": 106980
    }
}

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.SystemError Internal system error, which is irrelevant to the business.
InternalError.DbOperationFailed Internal system error with the database operation, which may be update, insert, select, etc.
InvalidParameter.EmptyParam The parameter is empty.
InvalidParameter.PermissionDenied The API has no CAM permissions.
InvalidParameterValue.UnSupportedType The instance type is not supported.
ResourceNotFound.InstanceNotExists No Redis instance is found by the serialId.
ResourceUnavailable.InstanceStatusError Operation unsupported: the instance is exceptional.
Contact Us

Contact our sales team or business advisors to help your business.

Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

7x24 Phone Support