文档首页/分布式缓存服务 DCS/API参考 (联盟区域) /API V2（推荐）/日志管理/查询Redis运行日志列表
更新时间：2025-12-29 GMT+08:00
查看PDF
分享

查询Redis运行日志列表

功能介绍

查询Redis运行日志列表。

URI

GET /v2/{project_id}/instances/{instance_id}/redislog

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

项目ID。获取方法请参见获取项目ID。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

instance_id

是

String

参数解释：

实例ID。可通过DCS控制台进入实例详情界面查看。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

表2 Query参数

参数

是否必选

参数类型

描述

offset

否

Integer

参数解释：

偏移量，表示生成的列表从此偏移量开始显示，例如偏移量为3时，生成的列表从第4条开始。

约束限制：

不涉及。

取值范围：

大于等于0。

默认取值：

0

limit

否

Integer

参数解释：

每页显示的条目数量。

约束限制：

不涉及。

取值范围：

1-1000

默认取值：

10

log_type

是

String

参数解释：

返回日志的类型。

约束限制：

不涉及。

取值范围：

run：Redis运行日志。

默认取值：

不涉及。

请求参数

无

响应参数

状态码：200

表3 响应Body参数

参数

参数类型

描述

total_num

Integer

参数解释：

日志总数。

取值范围：

不涉及。

file_list

Array of RunlogItem objects

参数解释：

运行日志列表。

表4 RunlogItem

参数

参数类型

描述

id

String

参数解释：

日志的唯一标识。

取值范围：

不涉及。

file_name

String

参数解释：

运行日志文件名。

取值范围：

不涉及。

group_name

String

参数解释：

分片名称。

取值范围：

不涉及。

replication_ip

String

参数解释：

采集运行日志所在副本的IP。

取值范围：

不涉及。

status

String

参数解释：

获取运行日志状态。

取值范围：

  • succeed：成功。

  • failed：失败。

time

String

参数解释：

运行日志采集的日期，格式为"yyyy-MM-dd"。

取值范围：

不涉及。

backup_id

String

参数解释：

日志文件的ID。

取值范围：

不涉及。

状态码：204

查询成功，无Redislog。

状态码：400

表5 响应Body参数

参数

参数类型

描述

error_msg

String

参数解释：

错误信息。

取值范围：

不涉及。

error_code

String

参数解释：

错误码。

取值范围：

请参见错误码。

error_ext_msg

String

参数解释：

扩展错误信息（暂未使用，赋值为null）。

取值范围：

不涉及。

状态码：401

表6 响应Body参数

参数

参数类型

描述

error_msg

String

参数解释：

错误信息。

取值范围：

不涉及。

error_code

String

参数解释：

错误码。

取值范围：

请参见错误码。

error_ext_msg

String

参数解释：

扩展错误信息（暂未使用，赋值为null）。

取值范围：

不涉及。

状态码：403

表7 响应Body参数

参数

参数类型

描述

error_msg

String

参数解释：

错误信息。

取值范围：

不涉及。

error_code

String

参数解释：

错误码。

取值范围：

请参见错误码。

error_ext_msg

String

参数解释：

扩展错误信息（暂未使用，赋值为null）。

取值范围：

不涉及。

状态码：404

表8 响应Body参数

参数

参数类型

描述

error_msg

String

参数解释：

错误信息。

取值范围：

不涉及。

error_code

String

参数解释：

错误码。

取值范围：

请参见错误码。

error_ext_msg

String

参数解释：

扩展错误信息（暂未使用，赋值为null）。

取值范围：

不涉及。

状态码：500

表9 响应Body参数

参数

参数类型

描述

error_msg

String

参数解释：

错误信息。

取值范围：

不涉及。

error_code

String

参数解释：

错误码。

取值范围：

请参见错误码。

error_ext_msg

String

参数解释：

扩展错误信息（暂未使用，赋值为null）。

取值范围：

不涉及。

请求示例

GET https://{dcs_endpoint}/v2/a4d31cb6-3d72-4fdc-8ec9-6e3a41e47f71/instances/5560df16-cebf-4473-95c4-d1b573c16e79/redislog?log_type=run&offset=1&limit=10&replication_id=50fa23b4-74d3-4d5c-98b9-39188a1f2daf

响应示例

状态码：200

查询运行日志成功。如果没有日志则会返回'204'。

{
  "total_num" : 1,
  "file_list" : [ {
    "id" : "e79f2d97-e972-41f2-b51c-d18f65f39a45",
    "file_name" : "redis_192.168.0.142_2021-04-16.log",
    "status" : "succeed",
    "time" : "2021-04-16",
    "replication_ip" : "192.168.0.142",
    "group_name" : "group-0",
    "backup_id" : "e79f2d97-e972-41f2-b51c-d18f65f39a45"
  } ]
}

状态码：400

非法请求。

{
  "error_code" : "DCS.4800",
  "error_msg" : "Invalid logType."
}

状态码

状态码

描述

200

查询运行日志成功。如果没有日志则会返回'204'。

204

查询成功，无Redislog。

400

非法请求。

401

认证失败。

403

请求被拒绝。

404

路径错误。

500

内部错误。

错误码

请参见错误码。

父主题：日志管理