DescribeSlowLogs--缓存数据库 Redis 版-火山引擎

文档中心

立即注册

导航

DescribeSlowLogs

最近更新时间：2024.07.18 22:55:12首次发布时间：2022.08.05 11:57:33

调用 DescribeSlowLogs 接口查询目标 Redis 实例在指定时间内的慢日志详情。

请求类型

同步请求。

注意事项

仅支持查看最近 3 天内的慢日志详情。
Block 类命令的执行时长、通信时长和等待时长超过了阈值也不会被记录到慢日志中。更多详情，请参见功能介绍。
Block 类命令包含下表中的所有命令。
命令族具体命令
Lists BLPOP、BRPOP、BRPOPLPUSH
SortedSets BZPOPMIN、BZPOPMAX
Streams XREAD、XREADGROUP

命令族	具体命令
Lists	BLPOP、BRPOP、BRPOPLPUSH
SortedSets	BZPOPMIN、BZPOPMAX
Streams	XREAD、XREADGROUP

请求参数

参数	类型	是否必选	示例值	描述
InstanceId	String	是	redis-cn02sg5o56sbs****	实例 ID。说明您可以调用 DescribeDBInstances 接口查询目标地域下所有 Redis 实例的基本信息，包括实例 ID。
PageSize	Integer	是	50	每页记录数，取值范围为 1~1000。
NodeIds	String[]	否	["proxy-redis-cn02sg5o56sbs**-1", "proxy-redis-cn02sg5o56sbs**-0"]	需要查询慢日志的节点 ID。说明若该参数留空，默认查询目标实例内所有节点的慢日志详情。支持同时传入多个节点 ID 进行查询，多个节点 ID 间用英文逗号（,）分隔。您可以调用 DescribeNodeIds 接口查询目标 Redis 实例下所有的节点 ID 信息。 `NodeIds` 的字符串总长度不可以超过 1024 个字节，建议传入的节点数量不超过 8 个。
SlowLogType	String	否	Proxy	慢日志的类型。取值范围如下： `Server`：Server 节点慢日志。 `Proxy`：Proxy 节点慢日志。说明若该参数留空，默认返回所有节点类型的慢日志。若同时传入 `NodeIds` 和 `SlowLogType`，以 `NodeIds` 取值为准。
QueryStartTime	String	否	2022-07-26T12:37:54Z	查询开始时间，格式为 `yyyy-MM-ddTHH:mmZ`（UTC）。说明若该参数留空，实际查询开始时间默认为当前时间 3 天前的时间。例如，当前时间为 2022 年 08 月 01 号 16:30:00，若 `QueryStartTime` 不填，那么实际查询开始时间为 2022 年 07 月 29 号 16:30:00。
QueryEndTime	String	否	2022-07-26T12:38:54Z	查询结束时间，格式为 `yyyy-MM-ddTHH:mmZ`（UTC）。说明若该参数留空，实际查询结束时间默认为当前时间。查询结束时间需晚于查询开始时间。
DBName	String	否	0	慢日志所在的数据库。慢日志类型不同，支持的数据库取值范围不同，其中： Proxy 节点慢日志：0 到 256 间的任意整数。 Server 节点慢日志：由于 Server 节点慢日志的数据库为空，故取值仅支持 `-`。说明若该参数留空，默认返回所有数据库上的慢日志。
Context	String	否	[1658839101000000,69550,0,null]	慢日志记录查询结果的上下文，需要加载更多慢日志记录时使用。说明调用 DescribeSlowLogs 接口后，您可以根据返回参数 `ListOver` 的值来确定是否还有未加载的慢日志记录：若 `ListOver` 的值为 `false`，表示还有符合查询条件的慢日志记录未加载完，您可以再次调用 DescribeSlowLogs 接口，并使用上一次接口调用时返回参数中的 `Context` 值来查看剩余的慢日志记录。若 `ListOver` 的值为 `true`，表示已加载完全部符合查询条件的慢日志记录。

返回参数

参数	类型	示例值	描述
Total	Integer	1	查询结果总条目数。
InstanceId	String	redis-cn02sg5o56sbs****	实例 ID。
ListOver	Boolean	true	慢日志日志内容是否已全部加载。取值范围如下： `true`：已全部加载。 `false`：未全部加载。说明若 `ListOver` 返回 `false`，您可以再次调用 DescribeSlowLogs，并在请求参数中传入 `Context` 返回的值，来查询未加载完的慢日志详情。
Context	String	[1658839101000000,69550,0,null]	慢日志记录查询结果的上下文，需要加载更多慢日志记录时使用。
SlowQuery	Object[]		慢日志详情。

示例

请求示例

POST https://redis.volcengineapi.com/?Action=DescribeSlowLogs&Version=2020-12-07 HTTP/1.1
Host: redis.volcengineapi.com
Content-Type: application/json; charset=utf-8
X-Date: 20201103T104027Z
Authorization: HMAC-SHA256 Credential=AK****/20201103/cn-beijing/Redis/request,SignedHeaders=content-type;host;x-date,Signature=****
{
    "InstanceId":"redis-cn02sg5o56sbs****",
    "NodeIds":[
        "proxy-redis-cn02sg5o56sbs****-0",
        "proxy-redis-cn02sg5o56sbs****-1"
    ],
    "QueryStartTime":"2022-07-26T12:37:54Z",
    "QueryEndTime":"2022-07-26T12:38:54Z",
    "PageSize":50
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202207262048480102250842170107****",
        "Action": "DescribeSlowLogs",
        "Version": "2020-12-07",
        "Service": "Redis",
        "Region": "cn-beijing"
    },
    "Result": {
        "Context": "[1658839101000000,69550,0,null]",
        "InstanceId": "redis-cn02sg5o56sbs****",
        "ListOver": true,
        "SlowQuery": [
            {
                "DBName": "0",
                "ExecutionStartTime": "2022-07-26T12:37:38Z",
                "HostAddress": "172.22.***.***:47502",
                "InstanceId": "redis-redis-cn02sg5o56sbs****",
                "NodeId": "proxy-redis-redis-cn02sg5o56sbs****-0",
                "QueryText": "INFO",
                "QueryTimes": 22073438,
                "UserName": "default"
            }
        ],
        "Total": 1
    }
}

错误码

更多详情，请参见错误码。