1. 接口描述
接口请求域名： redis.tencentcloudapi.com 。
查询日志
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeLogs。 |
| Version | 是 | String | 公共参数，本接口取值：2018-04-12。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| InstanceId | 是 | String | 指定实例 ID。例如：crs-xjhsdj。请登录Redis控制台在实例列表复制实例 ID。 示例值：crs-k2vh |
| StartTime | 是 | String | 日志检索的起始时间。 参数格式：YYYY-MM-DD HH:mm:ss，例如 2026-03-06 00:00:00。返回结果中仅包含该时间点及之后的日志。 示例值：2025-12-11 14:00:09 |
| EndTime | 是 | String | 日志检索的结束时间。 参数格式：YYYY-MM-DD HH:mm:ss，例如 2026-03-06 23:59:59。返回结果中仅包含该时间点及之前的日志。 示例值：2025-12-11 14:50:09 |
| LogType | 是 | String | 日志类型。 枚举值：
示例值：auditLog |
| LogFilter.N | 否 | Array of LogFilter | 过滤条件 |
| Limit | 否 | Integer | 每页返回的日志列表大小。
示例值：100 |
| Offset | 否 | Integer | 分页的起始偏移量。
示例值：0 |
| Order | 否 | String | 日志排序方式，默认值为 DESC。取值如下：
示例值：DESC |
| OrderBy | 否 | String | 排序字段，指定按哪个字段对日志进行排序。 示例值：Timestamp |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TotalCount | Integer | 查询的日志总数量。 示例值：10 |
| Items | Array of LogResult | 日志详情。 注意：此字段可能返回 null，表示取不到有效值。 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 请求示例
输入示例
POST / HTTP/1.1
Host: redis.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeLogs
<公共请求参数>
{
"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"
}
}5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
该接口暂无业务逻辑相关的错误码，其他错误码详见 公共错误码。
