Domain name for API request: redis.intl.tencentcloudapi.com.
This API is used to query logs.
A maximum of 20 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: DescribeLogs. |
| 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 | Specify the instance ID. Example: crs-xjhsdj****. Log in to the Redis console and copy the instance ID from the instance list. |
| StartTime | Yes | String | Start time of retrieval. Parameter format: YYYY-MM-DD HH:mm:ss, for example 2026-03-06 00:00:00. The returned result contains only the logs at this time point and afterward. |
| EndTime | Yes | String | End time of log retrieval. Parameter format: YYYY-MM-DD HH:mm:ss, for example 2026-03-06 23:59:59. The returned result contains only the logs at this time point and earlier. |
| LogType | Yes | String | Log type. Enumeration value:
|
| LogFilter.N | No | Array of LogFilter | Filter conditions. |
| Limit | No | Integer | List size of returned logs per page.
|
| Offset | No | Integer | Starting offset amount of pagination.
|
| Order | No | String | Log sorting method. Default value is DESC. Values are as follows:
|
| OrderBy | No | String | Sorting field. Specifies the field used to sort logs. |
| Parameter Name | Type | Description |
|---|---|---|
| TotalCount | Integer | Total log quantity of the query. |
| Items | Array of LogResult | Log 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. |
POST / HTTP/1.1
Host: redis.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeLogs
<Common request parameters>
{
"InstanceId": "crs-k2vh****",
"StartTime": "2025-12-11 14:00:09",
"EndTime": "2025-12-11 14:50:09",
"LogType": "auditLog"
}{
"Response": {
"Items": [
{
"CacheCode": "b606eeb",
"ClientAddr": "************:****",
"CommandDetail": "set ****-audit-test-*** 1",
"CommandLatency": 1,
"CommandType": "WRITE",
"Timestamp": "2025-12-11 14:49:40.815",
"DBId": 0,
"ErrMsg": "",
"UserName": "default"
}
],
"TotalCount": 10,
"RequestId": "4f90d880-5c00-4e3c-a153-12b7f2e18226"
}
}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.ServiceAccessError | Failed to access the Log service. Please retry later. If it remains unsuccessful, contact our customer service for assistance. |
| InvalidParameter.InvalidParameterError | Invalid parameter. |
| InvalidParameterValue.DataConvertError | Data conversion failed |
| InvalidParameterValue.InvalidParameterValueError | Illegal input. |
フィードバック