DescribeCacheAnalysisReport - Tair (Redis® OSS-Compatible)

Queries the cache analytics report that is generated on a specified date for an ApsaraDB for Redis instance.

Operation description

Note ApsaraDB for Redis has optimized the cache analytics feature to improve user experience. This API operation is phased out. You can use the new API operation for cache analytics. For more information, see API operations for cache analytics are upgraded.

Before you call this operation, make sure that the instance meets the following requirements:

The engine version of the instance is Redis 4.0 or later.
The instance uses the latest minor version. For more information about how to check whether to update the minor version of an instance, see How do I check whether the minor version of an ApsaraDB for Redis instance is the latest?

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
kvstore:DescribeCacheAnalysisReport	get	dbinstance acs:kvstore:{#regionId}:{#accountId}:dbinstance/{#dbInstanceId}	none	none

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The ID of the instance.	-bp1zxszhcgatnx****
Date	string	Yes	The date to query. You can query the report for one day each time. Specify the date in the yyyy-MM-ddZ format. The time must be in UTC.	2019-08-05Z
AnalysisType	string	Yes	The type of analytics. Set the value to BigKey. Enumeration Value: HotKey BigKey	BigKey
PageSize	integer	No	The number of entries to return on each page. Valid values: 30, 50, and 100. Note The default value is 30.	30
PageNumbers	integer	No	The number of the page to return. Note If the parameter value exceeds the maximum number of the returned pages, an empty large key list is returned.	1
NodeId	string	No	The ID of the child node in the cluster instance. Note If this parameter is not specified, the analytics results of all child nodes in the instance are returned.	-bp1zxszhcgatnx****-db-0

Response parameters

Parameter	Type	Description	Example
	object
PageNumber	integer	The page number of the returned page.	1
PageSize	integer	The maximum number of entries returned per page.	30
RequestId	string	The ID of the request.	A057C066-C3F5-4CC9-9FE4-A8D8B0DC****
PageRecordCount	integer	The number of entries returned on the current page.	30
TotalRecordCount	integer	The total number of entries returned.	160
BigKeys	array<object>	Details of the large keys.
BigKeys	object	The large key involved.	[{"db": "0", "qps": 0, "keyType": "list", "isExpired": "no", "analysisType": "BIGKEY", "key": "mylist", "memory": 1005377, "size": 200000}]
HotKeys	array<object>	Details of the hotkeys. Note This parameter is not returned because ApsaraDB for Redis does not support hotkey analytics.
HotKeys	object	The hot key involved.	[]

Examples

Sample success responses

JSONformat

{
  "PageNumber": 1,
  "PageSize": 30,
  "RequestId": "A057C066-C3F5-4CC9-9FE4-A8D8B0DC****",
  "PageRecordCount": 30,
  "TotalRecordCount": 160,
  "BigKeys": [
    [
      {
        "db": "0",
        "qps": 0,
        "keyType": "list",
        "isExpired": "no",
        "analysisType": "BIGKEY",
        "key": "mylist",
        "memory": 1005377,
        "size": 200000
      }
    ]
  ],
  "HotKeys": [
    []
  ]
}

Error codes

HTTP status code	Error code	Error message
403	IncorrectEngineVersion	Current engine version does not support this operation.

For a list of error codes, visit the Service error codes.