Domain name for API request: cdb.intl.tencentcloudapi.com.
This API is used to search for instance slow logs under usage conditions. Only allow viewing slow logs within one month.
During use, pay attention: a single slow log may be too large, causing the entire http request return content to be too large, furthermore leading to API timeout. Once timed out, narrow down the Limit parameter value when querying, thereby reducing the size and enabling the API to return content promptly.
A maximum of 50 requests can be initiated per second for this API.
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, which can be obtained through the DescribeDBInstances API. |
| StartTime | Yes | Integer | Session start timestamp. For example, 1585142640. Description: This parameter is a timestamp in seconds. |
| EndTime | Yes | Integer | End timestamp. Example: 1585142640. Description: This parameter is a timestamp in seconds. |
| 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 | Sorting field. Currently supported fields and their meanings are as follows. Default value is Timestamp. 1. Timestamp: SQL execution time 2. QueryTime: SQL execution duration (seconds) 3. LockTime: Lock duration (seconds) 4. RowsExamined: Number of scanned rows 5. RowsSent: Result set row count |
| OrderBy | No | String | Ascending or descending order. Valid values: "ASC" - Ascending order, "DESC" - Descending order. Default value: "ASC". |
| Offset | No | Integer | Offset. The default is 0, and the maximum is 9999. |
| Limit | No | Integer | The number of records returned in a single use, default is 100, maximum is 800. |
| InstType | No | String | This parameter is valid only for source or disaster recovery instances. Valid value: slave, which indicates pulling logs from the replica. |
| OpResourceId | No | String | Node ID. |
| Parameter Name | Type | Description |
|---|---|---|
| TotalCount | Integer | Number of eligible entries. |
| Items | Array of SlowLogItem | Queried 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. |
POST / HTTP/1.1
Host: cdb.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeSlowLogData
<Common request parameters>
{
"OrderBy": "DESC",
"UserNames": [
"usename0"
],
"InstanceId": "cdb-c1nl9rpv",
"DataBases": [
"database0"
],
"Offset": 0,
"Limit": 400,
"SortBy": "RowsSent",
"StartTime": 1585142640,
"UserHosts": [
"userhosts0"
],
"EndTime": 1585142640
}
{
"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"
}
]
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
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 | Data volume is too large. Reduce the data query range. |
| 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 instance 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.
Help us improve! Rate your documentation experience in 5 mins.
Feedback