tencent cloud

文档反馈

DescribeProxySlowLog

最后更新时间:2024-04-03 11:33:17

    1. API Description

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

    This API is used to query the slow queries of the proxy.

    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: DescribeProxySlowLog.
    Version Yes String Common Params. The value used for this API: 2018-04-12.
    Region No String Common Params. This parameter is not required for this API.
    InstanceId Yes String ID of a specified instance, such as "crs-xjhsdj****" Log in to the Redis console and copy the instance ID in the instance list.
    BeginTime Yes String Start time of slow query
    EndTime Yes String End time of slow query
    MinQueryTime No Integer Slow query threshold in milliseconds
    Limit No Integer Number of results per page. Default value: 20. Value range: [20,1000].
    Offset No Integer Offset, which is an integral multiple of Limit.

    3. Output Parameters

    Parameter Name Type Description
    TotalCount Integer Total number of slow queries
    InstanceProxySlowLogDetail Array of InstanceProxySlowlogDetail Slow query details
    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 Sample request

    This example shows you how to query the slow log record of a specified instance.

    Input Example

    https://redis.tencentcloudapi.com/?Action=DescribeProxySlowLog&InstanceId=crs-asda****&BeginTime=2019-09-08 12:12:41&EndTime=2019-09-09 12:12:41&<Common request parameters>
    

    Output Example

    {
        "Response": {
            "TotalCount": 106980,
            "InstanceProxySlowLogDetail": [
                {
                    "Duration": 45,
                    "ExecuteTime": "2019-09-08 12:13:08",
                    "CommandLine": "hget hash_key classify_scope::default",
                    "Client": "172.16.21.78",
                    "Command": "hget"
                }
            ],
            "RequestId": "121d5b40-d2b8-11e9-8c40-ef686158cbd6"
        }
    }
    

    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.
    FailedOperation.Unknown Invalid data is entered for weekday.
    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.
    ResourceNotFound.InstanceNotExists No Redis instance is found by the serialId.
    ResourceUnavailable.InstanceStatusAbnormal The Redis status is exceptional, and the corresponding process cannot be executed.
    ResourceUnavailable.InstanceStatusError Operation unsupported: the instance is exceptional.