Creates a cache analysis task.

Before you call this operation, make sure that the following conditions are met:

  • This operation is applicable only to ApsaraDB for Redis Community Edition and ApsaraDB for Redis Enhanced Edition (Tair).
  • When you use an Alibaba Cloud SDK, make sure that the aliyun-sdk-core version is later than V4.3.3. We recommend that you use the latest version.
  • The version of Database Autonomy Service (DAS) SDK must be V1.0.3 or later.
  • When you call this operation to use DAS, you must specify cn-shanghai as the region.

Request parameters

Parameter Type Required Example Description
Action String Yes CreateCacheAnalysisJob

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

InstanceId String Yes r-bp18ff4a195d****

The ID of the ApsaraDB for Redis instance.

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

The ID of the data node on the instance. You can specify this parameter to query the monitoring information about the specified node.

Note If you specify the BackupSetId parameter, the system ignores the NodeId parameter. You can call the DescribeLogicInstanceTopology operation to query the node ID.
BackupSetId String No 12345

The ID of the backup file. You can call the DescribeBackups operation to query the ID.

Note If the ApsaraDB for Redis instance is a cluster instance or a read/write splitting instance, this parameter must be specified. If you need to specify multiple backup file IDs, separate them with commas (,). For example, you can set this parameter to 12345,67890.
Note If the ApsaraDB for Redis instance is a standard instance and this parameter is not specified, the system automatically backs up the instance and performs cache analysis on the backup file.

Response parameters

Parameter Type Example Description
Message String Successful

The message returned for the request.

Note If the request is successful, Successful is returned. If the request fails, an error message such as an error code is returned.
RequestId String B6D17591-B48B-4D31-9CD6-9B9796B2****

The ID of the request.

Data Object

The details about the cache analysis task.

TaskState String BACKUP

The status of the cache analysis task. Valid values:

  • BACKUP: The data is being backed up.
  • ANALYZING: The data is being analyzed.
  • FINISHED: The data is analyzed.
  • FAILED: An error occurred.
JobId String sf79-sd99-sa37-****

The ID of the cache analysis task.

Note This parameter can be used to query a specified cache analysis task. When you call the CreateCacheAnalysisJob operation, it takes some time to create a cache analysis task. As a result, the analysis results cannot be immediately returned. You can specify this parameter in the DescribeCacheAnalysisJob operation to query the analysis results of the specified cache analysis task.
Message String Successful

The message returned for the request.

Note If the request is successful, Successful is returned. If the request fails, an error message such as an error code is returned.
BigKeys Array of KeyInfo

The details about the big keys.

KeyInfo
Type String hash

The type of the ApsaraDB for Redis data structure.

Db Integer 0

The name of the database.

ExpirationTimeMillis Long 1596256542547

The timestamp when the key expires. Unit: milliseconds. The value 0 indicates that the key does not expire.

Key String task_x****

The name of the key.

Encoding String hashtable

The data type of the key.

Bytes Long 12345

The number of bytes that are occupied by the key.

NodeId String r-x****-db-0

The ID of the data node on the instance.

Count Long 127

The number of elements in the key.

InstanceId String r-bp18ff4a195d****

The ID of the instance.

NodeId String r-x****-db-0

The ID of the data node on the instance.

Code String 200

The returned status code.

Success String true

Indicates whether the request is successful. Valid values:

  • true: The request is successful.
  • false: The request failed.

Examples

Sample requests

http(s)://das.cn-shanghai.aliyuncs.com/?Action=CreateCacheAnalysisJob
&InstanceId=r-bp18ff4a195d****
&NodeId=r-x****-db-0
&BackupSetId=12345
&<Common request parameters>

Sample success responses

XML format

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

<CreateCacheAnalysisJobResponse>
    <Message>Successful</Message>
    <RequestId>B6D17591-B48B-4D31-9CD6-9B9796B2****</RequestId>
    <Data>
        <TaskState>BACKUP</TaskState>
        <JobId>sf79-sd99-sa37-****</JobId>
        <Message>Successful</Message>
        <BigKeys>
            <Type>hash</Type>
            <Db>0</Db>
            <ExpirationTimeMillis>1596256542547</ExpirationTimeMillis>
            <Key>task_x****</Key>
            <Encoding>hashtable</Encoding>
            <Bytes>12345</Bytes>
            <NodeId>r-x****-db-0</NodeId>
            <Count>127</Count>
        </BigKeys>
        <InstanceId>r-bp18ff4a195d****</InstanceId>
        <NodeId>r-x****-db-0</NodeId>
    </Data>
    <Code>200</Code>
    <Success>true</Success>
</CreateCacheAnalysisJobResponse>

JSON format

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

{
  "Message" : "Successful",
  "RequestId" : "B6D17591-B48B-4D31-9CD6-9B9796B2****",
  "Data" : {
    "TaskState" : "BACKUP",
    "JobId" : "sf79-sd99-sa37-****",
    "Message" : "Successful",
    "BigKeys" : [ {
      "Type" : "hash",
      "Db" : 0,
      "ExpirationTimeMillis" : 1596256542547,
      "Key" : "task_x****",
      "Encoding" : "hashtable",
      "Bytes" : 12345,
      "NodeId" : "r-x****-db-0",
      "Count" : 127
    } ],
    "InstanceId" : "r-bp18ff4a195d****",
    "NodeId" : "r-x****-db-0"
  },
  "Code" : "200",
  "Success" : "true"
}

Error codes

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