Queries the offline key analysis tasks for an ApsaraDB for Redis instance.

Note Alibaba Cloud has optimized the cache analytics feature of ApsaraDB for Redis 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 DescribeCacheAnalysisReportList

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

RegionId String No cn-hangzhou

The region ID of the instance.

InstanceId String Yes r-bp1zxszhcgatnx****

The ID of the instance.

Days Integer No 7

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

Note If automatic analysis has not started and manual analysis is not performed on the day when you query analysis results, no records are returned.
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.

NodeId String No r-bp1zxszhcgatnx****-db-0

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.

Response parameters

Parameter Type Example Description
InstanceId String 1041xxxx

The ID of the instance.

RequestId String 743D0A03-52DE-4E6F-8D09-EC1414CF****

The ID of the request.

DailyTasks Array of DailyTask

Details about the offline key analysis tasks.

DailyTask
Date String 2019-08-01Z

The date when the offline key analysis task was performed.

Tasks Array of Task

Details about the offline key analysis tasks.

Task
Status String success

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

  • success: The task is successful.
  • running: The task is running.
StartTime String 2019-08-01T19:08:49Z

The start time of the offline key analysis task.

TaskId String 156465****

The ID of the task.

NodeId String r-bp1zxszhcgatnx****-db-0

The ID of the child node in the cluster instance.

Examples

Sample requests

https://r-kvstore.aliyuncs.com?Action=DescribeCacheAnalysisReportList
&InstanceId=r-bp1zxszhcgatnx****
&<Common request parameters>

Sample success responses

XML format

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

<DescribeCacheAnalysisReportListResponse>
    <InstanceId>1041xxxx</InstanceId>
    <RequestId>BFB9478A-119E-4589-B02C-2D2EBE5E****</RequestId>
    <DailyTasks>
        <DailyTask>
            <Date>2019-08-03Z</Date>
            <Tasks>
                <Task>
                    <Status>success</Status>
                    <NodeId>r-bp1zxszhcgatnx****-db-0</NodeId>
                    <StartTime>2019-08-03T19:08:48Z</StartTime>
                    <TaskId>156483****</TaskId>
                </Task>
                <Task>
                    <Status>success</Status>
                    <NodeId>r-bp1zxszhcgatnx****-db-1</NodeId>
                    <StartTime>2019-08-03T19:08:49Z</StartTime>
                    <TaskId>156483****</TaskId>
                </Task>
            </Tasks>
        </DailyTask>
        <DailyTask>
            <Date>2019-08-02Z</Date>
            <Tasks>
                <Task>
                    <Status>success</Status>
                    <NodeId>r-bp1zxszhcgatnx****-db-0</NodeId>
                    <StartTime>2019-08-02T19:08:55Z</StartTime>
                    <TaskId>156474****</TaskId>
                </Task>
                <Task>
                    <Status>success</Status>
                    <NodeId>r-bp1zxszhcgatnx****-db-1</NodeId>
                    <StartTime>2019-08-02T19:08:55Z</StartTime>
                    <TaskId>156474****</TaskId>
                </Task>
            </Tasks>
        </DailyTask>
    </DailyTasks>
</DescribeCacheAnalysisReportListResponse>

JSON format

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

{
  "InstanceId" : "1041xxxx",
  "RequestId" : "BFB9478A-119E-4589-B02C-2D2EBE5E****",
  "DailyTasks" : {
    "DailyTask" : [ {
      "Date" : "2019-08-03Z",
      "Tasks" : {
        "Task" : [ {
          "Status" : "success",
          "NodeId" : "r-bp1zxszhcgatnx****-db-0",
          "StartTime" : "2019-08-03T19:08:48Z",
          "TaskId" : "156483****"
        }, {
          "Status" : "success",
          "NodeId" : "r-bp1zxszhcgatnx****-db-1",
          "StartTime" : "2019-08-03T19:08:49Z",
          "TaskId" : "156483****"
        } ]
      }
    }, {
      "Date" : "2019-08-02Z",
      "Tasks" : {
        "Task" : [ {
          "Status" : "success",
          "NodeId" : "r-bp1zxszhcgatnx****-db-0",
          "StartTime" : "2019-08-02T19:08:55Z",
          "TaskId" : "156474****"
        }, {
          "Status" : "success",
          "NodeId" : "r-bp1zxszhcgatnx****-db-1",
          "StartTime" : "2019-08-02T19:08:55Z",
          "TaskId" : "156474****"
        } ]
      }
    } ]
  }
}

Error codes

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