Queries the offline key analytic reports that were generated on a specific date for an ApsaraDB for Redis instance.

Note ApsaraDB for Redis has optimized the cache analytics feature to improve user experience. This API operation is phased out and replaced with a new API operation. For more information, see API operations for cache analysis will be upgraded.

Before you call this API operation, make sure that the ApsaraDB for Redis instance meets the following requirements:

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeCacheAnalysisReport

The operation that you want to perform. Set the value to DescribeCacheAnalysisReport.

RegionId String No cn-hangzhou

The region ID of the instance.

InstanceId String Yes -bp1zxszhcgatnx****

The ID of the instance.

Date String Yes 2019-08-05Z

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.

AnalysisType String Yes BigKey

The type of analysis. Set the value to BigKey.

PageSize Integer No 30

The number of entries to return on each page. Valid values: 30, 50, and 100.

Note Default value: 30.
PageNumbers Integer No 1

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.
NodeId String No -bp1zxszhcgatnx****-db-0

The ID of the child node in the ApsaraDB for Redis cluster instance.

Note If you do not specify this parameter, the analytic reports of all child nodes in the instance are returned.

Response parameters

Parameter Type Example Description
PageNumber Integer 1

The page number of the returned page.

PageSize Integer 30

The maximum number of entries returned per page.

RequestId String A057C066-C3F5-4CC9-9FE4-A8D8B0DC****

The ID of the request.

PageRecordCount Integer 30

The number of entries returned on the current page.

TotalRecordCount Integer 160

The total number of entries returned.

BigKeys Array of Object [{"db": "0", "qps": 0, "keyType": "list", "isExpired": "no", "analysisType": "BIGKEY", "key": "mylist", "memory": 1005377, "size": 200000}]

Details about the large keys.

HotKeys Array of Object []

Details about the hotkeys.

Note This parameter is not returned because ApsaraDB for Redis does not support hotkey analysis for the moment.

Examples

Sample requests

https://r-kvstore.aliyuncs.com/?Action=DescribeCacheAnalysisReport
&AnalysisType=BigKey
&Date=2019-08-05Z
&InstanceId=r-bp1zxszhcgatnx****
&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeCacheAnalysisReportResponse>
    <PageNumber>1</PageNumber>
	<TotalRecordCount>160</TotalRecordCount>
	<PageSize>30</PageSize>
	<RequestId>A057C066-C3F5-4CC9-9FE4-A8D8B0DC****</RequestId>
	<BigKeys>
		<db>0</db>
		<qps>0</qps>
		<keyType>list</keyType>
		<isExpired>no</isExpired>
		<analysisType>BIGKEY</analysisType>
		<key>mylist</key>
		<memory>1005377</memory>
		<size>200000</size>
	</BigKeys>
	<BigKeys>
		<db>0</db>
		<qps>0</qps>
		<keyType>hash</keyType>
		<isExpired>no</isExpired>
		<analysisType>BIGKEY</analysisType>
		<key>customer:23124</key>
		<memory>970</memory>
		<size>11</size>
	</BigKeys>
	<BigKeys>
		<db>0</db>
		<qps>0</qps>
		<keyType>hash</keyType>
		<isExpired>no</isExpired>
		<analysisType>BIGKEY</analysisType>
		<key>customer:167541</key>
		<memory>967</memory>
		<size>11</size>
	</BigKeys>
	<BigKeys>
		<db>0</db>
		<qps>0</qps>
		<keyType>hash</keyType>
		<isExpired>no</isExpired>
		<analysisType>BIGKEY</analysisType>
		<key>customer:152015</key>
		<memory>958</memory>
		<size>11</size>
	</BigKeys>
	<BigKeys>
		<db>0</db>
		<qps>0</qps>
		<keyType>hash</keyType>
		<isExpired>no</isExpired>
		<analysisType>BIGKEY</analysisType>
		<key>customer:30883</key>
		<memory>955</memory>
		<size>11</size>
	</BigKeys>
	<BigKeys>
		<db>0</db>
		<qps>0</qps>
		<keyType>hash</keyType>
		<isExpired>no</isExpired>
		<analysisType>BIGKEY</analysisType>
		<key>customer:81031</key>
		<memory>953</memory>
		<size>11</size>
	</BigKeys>
	<BigKeys>
		<db>0</db>
		<qps>0</qps>
		<keyType>hash</keyType>
		<isExpired>no</isExpired>
		<analysisType>BIGKEY</analysisType>
		<key>customer:152007</key>
		<memory>952</memory>
		<size>11</size>
	</BigKeys>
	<BigKeys>
		<db>0</db>
		<qps>0</qps>
		<keyType>hash</keyType>
		<isExpired>no</isExpired>
		<analysisType>BIGKEY</analysisType>
		<key>customer:161880</key>
		<memory>951</memory>
		<size>11</size>
	</BigKeys>
	<BigKeys>
		<db>0</db>
		<qps>0</qps>
		<keyType>hash</keyType>
		<isExpired>no</isExpired>
		<analysisType>BIGKEY</analysisType>
		<key>customer:194610</key>
		<memory>949</memory>
		<size>11</size>
	</BigKeys>
	<BigKeys>
		<db>0</db>
		<qps>0</qps>
		<keyType>hash</keyType>
		<isExpired>no</isExpired>
		<analysisType>BIGKEY</analysisType>
		<key>customer:53620</key>
		<memory>948</memory>
		<size>11</size>
	</BigKeys>
	<BigKeys>
		<db>0</db>
		<qps>0</qps>
		<keyType>hash</keyType>
		<isExpired>no</isExpired>
		<analysisType>BIGKEY</analysisType>
		<key>customer:23525</key>
		<memory>946</memory>
		<size>11</size>
	</BigKeys>
	<BigKeys>
		<db>0</db>
		<qps>0</qps>
		<keyType>hash</keyType>
		<isExpired>no</isExpired>
		<analysisType>BIGKEY</analysisType>
		<key>customer:89333</key>
		<memory>946</memory>
		<size>11</size>
	</BigKeys>
	<BigKeys>
		<db>0</db>
		<qps>0</qps>
		<keyType>hash</keyType>
		<isExpired>no</isExpired>
		<analysisType>BIGKEY</analysisType>
		<key>customer:23687</key>
		<memory>945</memory>
		<size>11</size>
	</BigKeys>
	<BigKeys>
		<db>0</db>
		<qps>0</qps>
		<keyType>hash</keyType>
		<isExpired>no</isExpired>
		<analysisType>BIGKEY</analysisType>
		<key>customer:32653</key>
		<memory>945</memory>
		<size>11</size>
	</BigKeys>
	<BigKeys>
		<db>0</db>
		<qps>0</qps>
		<keyType>hash</keyType>
		<isExpired>no</isExpired>
		<analysisType>BIGKEY</analysisType>
		<key>customer:72166</key>
		<memory>945</memory>
		<size>11</size>
	</BigKeys>
	<BigKeys>
		<db>0</db>
		<qps>0</qps>
		<keyType>hash</keyType>
		<isExpired>no</isExpired>
		<analysisType>BIGKEY</analysisType>
		<key>customer:195881</key>
		<memory>944</memory>
		<size>11</size>
	</BigKeys>
	<BigKeys>
		<db>0</db>
		<qps>0</qps>
		<keyType>hash</keyType>
		<isExpired>no</isExpired>
		<analysisType>BIGKEY</analysisType>
		<key>customer:160121</key>
		<memory>944</memory>
		<size>11</size>
	</BigKeys>
	<BigKeys>
		<db>0</db>
		<qps>0</qps>
		<keyType>hash</keyType>
		<isExpired>no</isExpired>
		<analysisType>BIGKEY</analysisType>
		<key>customer:93626</key>
		<memory>944</memory>
		<size>11</size>
	</BigKeys>
	<BigKeys>
		<db>0</db>
		<qps>0</qps>
		<keyType>hash</keyType>
		<isExpired>no</isExpired>
		<analysisType>BIGKEY</analysisType>
		<key>customer:138451</key>
		<memory>944</memory>
		<size>11</size>
	</BigKeys>
	<BigKeys>
		<db>0</db>
		<qps>0</qps>
		<keyType>hash</keyType>
		<isExpired>no</isExpired>
		<analysisType>BIGKEY</analysisType>
		<key>customer:183732</key>
		<memory>943</memory>
		<size>11</size>
	</BigKeys>
	<BigKeys>
		<db>0</db>
		<qps>0</qps>
		<keyType>hash</keyType>
		<isExpired>no</isExpired>
		<analysisType>BIGKEY</analysisType>
		<key>customer:143393</key>
		<memory>943</memory>
		<size>11</size>
	</BigKeys>
	<BigKeys>
		<db>0</db>
		<qps>0</qps>
		<keyType>hash</keyType>
		<isExpired>no</isExpired>
		<analysisType>BIGKEY</analysisType>
		<key>customer:109289</key>
		<memory>943</memory>
		<size>11</size>
	</BigKeys>
	<BigKeys>
		<db>0</db>
		<qps>0</qps>
		<keyType>hash</keyType>
		<isExpired>no</isExpired>
		<analysisType>BIGKEY</analysisType>
		<key>customer:153637</key>
		<memory>942</memory>
		<size>11</size>
	</BigKeys>
	<BigKeys>
		<db>0</db>
		<qps>0</qps>
		<keyType>hash</keyType>
		<isExpired>no</isExpired>
		<analysisType>BIGKEY</analysisType>
		<key>customer:171049</key>
		<memory>942</memory>
		<size>11</size>
	</BigKeys>
	<BigKeys>
		<db>0</db>
		<qps>0</qps>
		<keyType>hash</keyType>
		<isExpired>no</isExpired>
		<analysisType>BIGKEY</analysisType>
		<key>customer:53013</key>
		<memory>941</memory>
		<size>11</size>
	</BigKeys>
	<BigKeys>
		<db>0</db>
		<qps>0</qps>
		<keyType>hash</keyType>
		<isExpired>no</isExpired>
		<analysisType>BIGKEY</analysisType>
		<key>customer:103664</key>
		<memory>941</memory>
		<size>11</size>
	</BigKeys>
	<BigKeys>
		<db>0</db>
		<qps>0</qps>
		<keyType>hash</keyType>
		<isExpired>no</isExpired>
		<analysisType>BIGKEY</analysisType>
		<key>customer:180733</key>
		<memory>941</memory>
		<size>11</size>
	</BigKeys>
	<BigKeys>
		<db>0</db>
		<qps>0</qps>
		<keyType>hash</keyType>
		<isExpired>no</isExpired>
		<analysisType>BIGKEY</analysisType>
		<key>customer:69766</key>
		<memory>941</memory>
		<size>11</size>
	</BigKeys>
	<BigKeys>
		<db>0</db>
		<qps>0</qps>
		<keyType>hash</keyType>
		<isExpired>no</isExpired>
		<analysisType>BIGKEY</analysisType>
		<key>customer:125910</key>
		<memory>940</memory>
		<size>11</size>
	</BigKeys>
	<BigKeys>
		<db>0</db>
		<qps>0</qps>
		<keyType>hash</keyType>
		<isExpired>no</isExpired>
		<analysisType>BIGKEY</analysisType>
		<key>customer:10653</key>
		<memory>940</memory>
		<size>11</size>
	</BigKeys>
	<PageRecordCount>30</PageRecordCount>
</DescribeCacheAnalysisReportResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "PageNumber" : 1,
  "TotalRecordCount" : 160,
  "HotKeys" : [ ],
  "PageSize" : 30,
  "RequestId" : "A057C066-C3F5-4CC9-9FE4-A8D8B0DC****",
  "BigKeys" : [ {
    "db" : "0",
    "qps" : 0,
    "keyType" : "list",
    "isExpired" : "no",
    "analysisType" : "BIGKEY",
    "key" : "mylist",
    "memory" : 1005377,
    "size" : 200000
  }, {
    "db" : "0",
    "qps" : 0,
    "keyType" : "hash",
    "isExpired" : "no",
    "analysisType" : "BIGKEY",
    "key" : "customer:23124",
    "memory" : 970,
    "size" : 11
  }, {
    "db" : "0",
    "qps" : 0,
    "keyType" : "hash",
    "isExpired" : "no",
    "analysisType" : "BIGKEY",
    "key" : "customer:167541",
    "memory" : 967,
    "size" : 11
  }, {
    "db" : "0",
    "qps" : 0,
    "keyType" : "hash",
    "isExpired" : "no",
    "analysisType" : "BIGKEY",
    "key" : "customer:152015",
    "memory" : 958,
    "size" : 11
  }, {
    "db" : "0",
    "qps" : 0,
    "keyType" : "hash",
    "isExpired" : "no",
    "analysisType" : "BIGKEY",
    "key" : "customer:30883",
    "memory" : 955,
    "size" : 11
  }, {
    "db" : "0",
    "qps" : 0,
    "keyType" : "hash",
    "isExpired" : "no",
    "analysisType" : "BIGKEY",
    "key" : "customer:81031",
    "memory" : 953,
    "size" : 11
  }, {
    "db" : "0",
    "qps" : 0,
    "keyType" : "hash",
    "isExpired" : "no",
    "analysisType" : "BIGKEY",
    "key" : "customer:152007",
    "memory" : 952,
    "size" : 11
  }, {
    "db" : "0",
    "qps" : 0,
    "keyType" : "hash",
    "isExpired" : "no",
    "analysisType" : "BIGKEY",
    "key" : "customer:161880",
    "memory" : 951,
    "size" : 11
  }, {
    "db" : "0",
    "qps" : 0,
    "keyType" : "hash",
    "isExpired" : "no",
    "analysisType" : "BIGKEY",
    "key" : "customer:194610",
    "memory" : 949,
    "size" : 11
  }, {
    "db" : "0",
    "qps" : 0,
    "keyType" : "hash",
    "isExpired" : "no",
    "analysisType" : "BIGKEY",
    "key" : "customer:53620",
    "memory" : 948,
    "size" : 11
  }, {
    "db" : "0",
    "qps" : 0,
    "keyType" : "hash",
    "isExpired" : "no",
    "analysisType" : "BIGKEY",
    "key" : "customer:23525",
    "memory" : 946,
    "size" : 11
  }, {
    "db" : "0",
    "qps" : 0,
    "keyType" : "hash",
    "isExpired" : "no",
    "analysisType" : "BIGKEY",
    "key" : "customer:89333",
    "memory" : 946,
    "size" : 11
  }, {
    "db" : "0",
    "qps" : 0,
    "keyType" : "hash",
    "isExpired" : "no",
    "analysisType" : "BIGKEY",
    "key" : "customer:23687",
    "memory" : 945,
    "size" : 11
  }, {
    "db" : "0",
    "qps" : 0,
    "keyType" : "hash",
    "isExpired" : "no",
    "analysisType" : "BIGKEY",
    "key" : "customer:32653",
    "memory" : 945,
    "size" : 11
  }, {
    "db" : "0",
    "qps" : 0,
    "keyType" : "hash",
    "isExpired" : "no",
    "analysisType" : "BIGKEY",
    "key" : "customer:72166",
    "memory" : 945,
    "size" : 11
  }, {
    "db" : "0",
    "qps" : 0,
    "keyType" : "hash",
    "isExpired" : "no",
    "analysisType" : "BIGKEY",
    "key" : "customer:195881",
    "memory" : 944,
    "size" : 11
  }, {
    "db" : "0",
    "qps" : 0,
    "keyType" : "hash",
    "isExpired" : "no",
    "analysisType" : "BIGKEY",
    "key" : "customer:160121",
    "memory" : 944,
    "size" : 11
  }, {
    "db" : "0",
    "qps" : 0,
    "keyType" : "hash",
    "isExpired" : "no",
    "analysisType" : "BIGKEY",
    "key" : "customer:93626",
    "memory" : 944,
    "size" : 11
  }, {
    "db" : "0",
    "qps" : 0,
    "keyType" : "hash",
    "isExpired" : "no",
    "analysisType" : "BIGKEY",
    "key" : "customer:138451",
    "memory" : 944,
    "size" : 11
  }, {
    "db" : "0",
    "qps" : 0,
    "keyType" : "hash",
    "isExpired" : "no",
    "analysisType" : "BIGKEY",
    "key" : "customer:183732",
    "memory" : 943,
    "size" : 11
  }, {
    "db" : "0",
    "qps" : 0,
    "keyType" : "hash",
    "isExpired" : "no",
    "analysisType" : "BIGKEY",
    "key" : "customer:143393",
    "memory" : 943,
    "size" : 11
  }, {
    "db" : "0",
    "qps" : 0,
    "keyType" : "hash",
    "isExpired" : "no",
    "analysisType" : "BIGKEY",
    "key" : "customer:109289",
    "memory" : 943,
    "size" : 11
  }, {
    "db" : "0",
    "qps" : 0,
    "keyType" : "hash",
    "isExpired" : "no",
    "analysisType" : "BIGKEY",
    "key" : "customer:153637",
    "memory" : 942,
    "size" : 11
  }, {
    "db" : "0",
    "qps" : 0,
    "keyType" : "hash",
    "isExpired" : "no",
    "analysisType" : "BIGKEY",
    "key" : "customer:171049",
    "memory" : 942,
    "size" : 11
  }, {
    "db" : "0",
    "qps" : 0,
    "keyType" : "hash",
    "isExpired" : "no",
    "analysisType" : "BIGKEY",
    "key" : "customer:53013",
    "memory" : 941,
    "size" : 11
  }, {
    "db" : "0",
    "qps" : 0,
    "keyType" : "hash",
    "isExpired" : "no",
    "analysisType" : "BIGKEY",
    "key" : "customer:103664",
    "memory" : 941,
    "size" : 11
  }, {
    "db" : "0",
    "qps" : 0,
    "keyType" : "hash",
    "isExpired" : "no",
    "analysisType" : "BIGKEY",
    "key" : "customer:180733",
    "memory" : 941,
    "size" : 11
  }, {
    "db" : "0",
    "qps" : 0,
    "keyType" : "hash",
    "isExpired" : "no",
    "analysisType" : "BIGKEY",
    "key" : "customer:69766",
    "memory" : 941,
    "size" : 11
  }, {
    "db" : "0",
    "qps" : 0,
    "keyType" : "hash",
    "isExpired" : "no",
    "analysisType" : "BIGKEY",
    "key" : "customer:125910",
    "memory" : 940,
    "size" : 11
  }, {
    "db" : "0",
    "qps" : 0,
    "keyType" : "hash",
    "isExpired" : "no",
    "analysisType" : "BIGKEY",
    "key" : "customer:10653",
    "memory" : 940,
    "size" : 11
  } ],
  "PageRecordCount" : 30
}

Error codes

For a list of error codes, visit the API Error Center.