All Products
Search
Document Center

Tair:DescribeCacheAnalysisReportList

Last Updated:Feb 20, 2024

Queries the cache analytics reports of 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:

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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.
OperationAccess levelResource typeCondition keyAssociated operation
kvstore:DescribeCacheAnalysisReportListREAD
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
InstanceIdstringYes

The ID of the instance.

r-bp1zxszhcgatnx****
DaysintegerNo

The time range to query. Default value: 7. Unit: days.

Note If daily automatic analysis has not started and manual analysis is not performed, no records are returned.
7
PageSizeintegerNo

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

Note The default value is 30.
30
PageNumbersintegerNo

The number of the page to return.

1
NodeIdstringNo

The ID of the child node in the cluster instance.

Note If this parameter is not specified, the analysis results of all child nodes in the instance are returned.
r-bp1zxszhcgatnx****-db-0

Response parameters

ParameterTypeDescriptionExample
object
InstanceIdstring

The ID of the instance.

1041xxxx
RequestIdstring

The ID of the request.

743D0A03-52DE-4E6F-8D09-EC1414CF****
DailyTasksobject []

Details of the offline key analytics tasks.

Datestring

The date when the offline key analytics task was performed.

2019-08-01Z
Tasksobject []

Details of the offline key analytics tasks.

Statusstring

The state of the offline key analytics task. Valid values:

  • success
  • running
success
StartTimestring

The start time of the offline key analytics task.

2019-08-01T19:08:49Z
TaskIdstring

The ID of the task.

156465****
NodeIdstring

The ID of the child node in the cluster instance.

r-bp1zxszhcgatnx****-db-0

Examples

Sample success responses

JSONformat

{
  "InstanceId": "1041xxxx",
  "RequestId": "743D0A03-52DE-4E6F-8D09-EC1414CF****",
  "DailyTasks": {
    "DailyTask": [
      {
        "Date": "2019-08-01Z",
        "Tasks": {
          "Task": [
            {
              "Status": "success",
              "StartTime": "2019-08-01T19:08:49Z",
              "TaskId": "156465****",
              "NodeId": "r-bp1zxszhcgatnx****-db-0"
            }
          ]
        }
      }
    ]
  }
}

Error codes

HTTP status codeError codeError message
403IncorrectEngineVersionCurrent engine version does not support this operation.

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