Queries the details of a specified cache analysis task.

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

  • This operation is applicable to only the Redis engine.
  • 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 SDK version for Database Autonomy Service (DAS) must be V1.0.2 or later.
  • When you use the SDK to call the DAS service, you must specify the region as cn-shanghai.

Request parameters

Parameter Type Required Example Description
Action String No DescribeCacheAnalysisJob

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

InstanceId String No r-bp18ff4a195d****

The ID of the instance.
JobId String No sf79-sd99-sa37-****

The ID of the analysis task.

Response parameters

Parameter Type Example Description
Code String 200

The returned status code.
Data Struct

The list of detailed information.
BigKeys Array of KeyInfo

The details of the big keys.
KeyInfo
Bytes Long 12345

The number of bytes that are occupied by the keys.
Count Long 127

The number of elements in the keys.
Db Integer 0

The name of the database.
Encoding String hashtable

The data type of the keys.
ExpirationTimeMillis Long 1596256542547

The time when the keys expire. Unit: millisecond. The value 0 indicates that the keys do not expire.

Key String task_x****

The name of the key.
NodeId String r-****-db-0

The ID of the sharded instance.
Type String hash

The type of the Redis data structure.
InstanceId String r-bp18ff4a195d****

The ID of the instance.
JobId String sf79-sd99-sa37-****

The ID of the cache analysis task.
KeyPrefixes Array of Prefix

The list of key prefixes.
Prefix
Bytes Long 3652000

The number of memory bytes that are occupied.
Count Long 1596256

The number of elements for the prefix.
KeyNum Long 123

The number of keys for the prefix.
Prefix String task_

The prefix of the keys.
Type String hash

The type of the Redis data structure.
Message String Successful

The returned message of the request.

Note If the request is successful, Successful is returned for this parameter. If the request fails, a request exception message such as an error code is returned.
NodeId String r-x****-db-0

The ID of the sharded instance.
TaskState String BACKUP

The status of the cache analysis task:

  • BACKUP: The data is being backed up.
  • ANALYZING: The task is in the analysis phase.
  • FINISHED: The analysis is complete.
  • FAILED: An error occurred.
Message String Successful

The returned message of the request.

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

The ID of the request.
Success String true

Indicates whether the request was successful.

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

Examples

Sample requests

https://das.cn-shanghai.aliyuncs.com/?Action=DescribeCacheAnalysisJob
&InstanceId=r-bp18ff4a195d****
&JobId=sf79-sd99-sa37-****
&<Common request parameters>

Sample success responses

XML format 

</DescribeCacheAnalysisJobReponse>
<RequestId> B6D17591-B48B-4D31-9CD6-9B9796B2270A</RequestId>
<Message>Successful</Message>
<Data>
    <KeyPrefixes>
        <Prefix>
            <Bytes>3652000</Bytes>
            <Type>hash</Type>
            <Count>1596256</Count>
            <Prefix>task_</Prefix>
            <KeyNum>123</KeyNum>
        </Prefix>
    </KeyPrefixes>
    <BigKeys>
        <KeyInfo>
            <Bytes>12345</Bytes>
            <Type>hash</Type>
            <NodeId>r-xxxx-db-0</NodeId>
            <ExpirationTimeMillis>1596256542547</ExpirationTimeMillis>
            <Encoding>hashtable</Encoding>
            <Count>127</Count>
            <Key>task_xxxxx</Key>
            <Db>0</Db>
        </KeyInfo>
    </BigKeys>
    <Message>Successful</Message>
    <InstanceId>r-xxxxxx</InstanceId>
    <NodeId>r-xxxxx-db-0</NodeId>
    <TaskState>BACKUP</TaskState>
    <JobId>xxxx-xxxx-xxxx-xxxx</JobId>
</Data>
<Code>200</Code>
<Success>true</Success>
</DescribeCacheAnalysisJobReponse>

JSON format 

{"RequestId":" B6D17591-B48B-4D31-9CD6-9B9796B2270A","Message":"Successful","Data":{"KeyPrefixes":{"Prefix":[{"Bytes":"3652000","Type":"hash","Count":"1596256","Prefix":"task_","KeyNum":"123"}]},"BigKeys":{"KeyInfo":[{"Bytes":"12345","Type":"hash","NodeId":"r-xxxx-db-0","ExpirationTimeMillis":"1596256542547",
"Encoding":"hashtable",
"Count":"127",
"Key":"task_xxxxx",
"Db":"0"}]},
"Message":"Successful",
"InstanceId":"r-xxxxxx",
"NodeId":"r-xxxxx-db-0",
"TaskState":"BACKUP",
"JobId":"xxxx-xxxx-xxxx-xxxx"},
"Code":"200",
"Success":"true"}

Error codes

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