Docs

Cache for Redis

Performance analysis

DescribeBigKeys

Call the DescribeBigKeys API to query large key details of the target Redis instance within a specified time range.

Request type

Synchronous request.

Precautions

You can only view the details of the top 100 keys with the highest memory usage or the most elements in a specified Redis instance within the past 15 days. For more details, refer to Big key analysis.

Debugging

API Explorer

You can initiate calls online through API Explorer without paying attention to the signature generation process and quickly obtain the call results.

Go to debug

Request parameters

Parameters	Type	Required	Example	Description
InstanceId	String	Yes	redis-cn02sg5o56sbs****	Instance ID. tip You can call the DescribeDBInstances API to query the basic information of all Redis instances in the target region, including the instance ID.
PageSize	Integer	Yes	50	Number of records on each page. Value range is any integer between 1 and 100.
QueryStartTime	String	No	2023-03-27T15:30:00Z	Query start time, in the format yyyy-MM-ddTHH:mm:ssZ (UTC). tip Only supports viewing big key distribution for the last 15 days. If this parameter is left empty, the actual query start time defaults to 24 hours before the current time. For example, if the current time is 2023-03-27 16:30:00, and QueryStartTime is left blank, the actual query start time will be 2023-03-26 16:30:00. The query end time must be later than the query start time, and the time interval should not exceed 24 hours.
QueryEndTime	String	No	2023-03-27T15:31:00Z	Query end time, in the format yyyy-MM-ddTHH:mm:ssZ (UTC). tip If this parameter is left blank, the actual query end time defaults to the current time. The query end time must be later than the query start time, and the time interval should not exceed 24 hours.
KeyType	String	No	list	Specify the data type used to filter big key query results. Supported data types: string list set zset hash tip If this parameter is left blank, data type filtering is not used.
OrderBy	String	No	ValueSize	Specify the sorting condition for query results. The following sorting conditions are supported: ValueSize (default): Sort big key query results by memory usage. ValueLen: Sort big key query results by the number of elements.

Response parameters

Parameters	Type	Example	Description
Total	Integer	1	Total number of query results.
InstanceId	String	redis-cn02sg5o56sbs****	Instance ID.
BigKey	Array of BigKeyInfo	Refer to the Sample response.	Big key details.

BigKeyInfo

Parameters	Type	Example	Description
DBName	String	2	The name of the database to which the big key belongs.
KeyInfo	String	key:000000000015	Name of the big key.
KeyType	String	string	Data type of the big key.
ValueLen	String	1	Number of elements contained in the big key. tip The number of elements for string type big keys defaults to 1. Non-string type big keys return the specific number of elements.
ValueSize	String	10241	Memory usage of the big key, unit: Byte. tip String-type big keys return specific memory usage. Non-string type big keys have empty memory usage by default.

Example

Request example

POST https://redis.cn-beijing.volcengineapi.com/?Action=DescribeBigKeys&Version=2020-12-07 HTTP/1.1​
Host: redis.cn-beijing.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****",​
    "QueryStartTime":"2023-03-20T12:37:54Z",​
    "QueryEndTime":"2023-03-20T12:38:54Z",​
    "PageSize":50​
}​

Response example

{​
    "ResponseMetadata": {​
        "RequestId": "202207262048480102250842170107xxxx",​
        "Action": "DescribeBigKeys",​
        "Version": "2020-12-07",​
        "Service": "Redis",​
        "Region": "cn-beijing"​
    },​
    "Result": {​
        "BigKey": [​
            {​
                "DBName": "2",​
                "KeyInfo": "key:000000000015",​
                "KeyType": "string",​
                "ValueLen": "1",​
                "ValueSize": "10241"​
            }​
        ],​
        "InstanceId": "redis-cn02sg5o56sbs****",​
        "Total": 1​
    }​
}​

Error code

For more details, see Error code.

Last updated: 2026.09.21 15:01:12