DescribeSlowLogData

Download PDF

Last updated: 2024-11-20 11:14:42

DescribeSlowLogData

Last updated: 2024-11-20 11:14:42

Download PDF

1. API Description

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

This API is used to query the slow logs of an instance over the past month by search criteria.
Note: the HTTP response packet will be very large if it contain a single large slow log, which causes the API call to time out. If this happens, we recommend you lower the value of the input parameter Limit to reduce the packet size so that the API can respond timely.

A maximum of 50 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: DescribeSlowLogData.
Version	Yes	String	Common Params. The value used for this API: 2017-03-20.
Region	Yes	String	Common Params. For more information, please see the list of regions supported by the product.
InstanceId	Yes	String	Instance ID.
StartTime	Yes	Integer	Start timestamp, such as 1585142640.
EndTime	Yes	Integer	End timestamp, such as 1585142640.
UserHosts.N	No	Array of String	Client `Host` list.
UserNames.N	No	Array of String	Client username list.
DataBases.N	No	Array of String	Accessed database list.
SortBy	No	String	Sort by field. Valid values: Timestamp, QueryTime, LockTime, RowsExamined, RowsSent.
OrderBy	No	String	Sorting order. Valid values: ASC (ascending), DESC (descending).
Offset	No	Integer	Offset. Default value: 0.
Limit	No	Integer	The number of results per page in paginated queries. Default value: 100. Maximum value: 400.
InstType	No	String	This parameter is valid only for source or disaster recovery instances. Valid value: `slave`, which indicates pulling logs from the replica.

3. Output Parameters

Parameter Name	Type	Description
TotalCount	Integer	Number of eligible entries.
Items	Array of SlowLogItem	Queried results. 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 Querying instance slow logs by search criteria

Input Example

https://cdb.intl.tencentcloudapi.com/?Action=DescribeSlowLogData
&InstanceId=cdb-c1nl9rpv
&StartTime=1585142640
&EndTime=1585142640
&UserNames.0=usename0
&DataBases.0=database0
&UserHosts.0=userhosts0
&SortBy=RowsSent
&OrderBy=DESC
&Limit=400
&Offset=0
&<Common request parameters>

Output Example

{
    "Response": {
        "RequestId": "6EF60BEC-0242-43AF-BB20-270359FB54A7",
        "TotalCount": 1,
        "Items": [
            {
                "Database": "1231231",
                "LockTime": 1,
                "Md5": "23123123",
                "QueryTime": 100,
                "RowsExamined": 0,
                "RowsSent": 0,
                "SqlTemplate": "show master status111111",
                "SqlText": "update order_logistics set logistics_status = 205 where logistics_id in ( select `logistics_id` from `order_info` where order_no in('15706082880074381752', '15706082880074381751'))",
                "Timestamp": 1585142640,
                "UserHost": "localhost",
                "UserName": "marchzcma"
            }
        ]
    }
}

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

Tencent Cloud CLI 3.0

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.LogContentOverLimit
FailedOperation.QueryLogError	Log query failed.
FailedOperation.ResultSetOverLimit	The result set size of queried logs exceeds the limit. Please select a shorter time range.
FailedOperation.TimeoutError	The query timed out.
InternalError.DBError	Database exception
InternalError.DBOperationError	Database operation failed.
InternalError.DBRecordNotExistError	The database record does not exist.
InternalError.InternalHttpServerError	An exception occurred while executing the request.
InvalidParameter	Parameter error.
InvalidParameter.InvalidParameterError	Invalid parameter value
InvalidParameterValue.DataConvertError	Data conversion failed.
InvalidParameterValue.InvalidParameterValueError	Invalid parameter value
OperationDenied	Operation denied.
OperationDenied.NotSupportBasic	Basic instances do not support this operation (feature).
OperationDenied.ResultOverLimit	The maximum number of results has been reached. Please narrow down your query.
ResourceNotFound.CdbInstanceNotFoundError	The instance cannot be found. Please check whether your instance status is normal.

Was this page helpful?

You can also Contact Sales or Submit a Ticket for help.

Yes

tencent cloud