DescribeCacheAnalysisJob - Database Autonomy Service

Queries the details of a cache analysis task.

Operation description

Before you call this operation, take note of the following items:

If you use an Alibaba Cloud SDK or a Database Autonomy Service (DAS) SDK to call this operation, we recommend that you use the latest version of the SDK.
If you use an SDK to call the API operations of DAS, you must set the region ID to cn-shanghai.
This operation is applicable only to ApsaraDB for Redis.

Note You can call this operation to query the top 500 keys in a cache analysis task.

Debugging

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

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
hdm:DescribeCacheAnalysisJob	get	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The ID of the instance.	r-bp18ff4a195d****
JobId	string	Yes	The ID of the cache analysis task. You can obtain the task ID from the response parameters of the CreateCacheAnalysisJob operation.	sf79-sd99-sa37-****

Response parameters

Parameter	Type	Description	Example
	object
Message	string	The message that is returned for the request. Note If the request is successful, Successful is returned. If the request fails, an error message that contains information such as an error code is returned.	Successful
RequestId	string	The ID of the request.	B6D17591-B48B-4D31-9CD6-9B9796B2****
Data	object	The details of the cache analysis task.
TaskState	string	The state 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.	BACKUP
JobId	string	The ID of the cache analysis task.	sf79-sd99-sa37-****
Message	string	The message that is returned for the request. Note If the request is successful, Successful is returned. If the request fails, an error message that contains information such as an error code is returned.	Successful
BigKeys	array<object>	The details of the large keys. The returned large keys are sorted in descending order based on the number of bytes occupied by the keys.
KeyInfo	object
Type	string	The data type of the instance.	hash
Db	integer	The database name.	0
ExpirationTimeMillis	long	The time when the key expires. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC. A value of 0 indicates that the key never expires.	1596256542547
Key	string	The key name.	task_x****
Encoding	string	The data type of the key.	hashtable
Bytes	long	The number of bytes that are occupied by the key.	12345
NodeId	string	The ID of the data node on the instance.	r-x****-db-0
Count	long	The number of elements in the key.	127
KeyPrefixes	array<object>	The prefixes of the keys.
Prefix	object
KeyNum	long	The number of keys that contain the prefix.	123
Type	string	The data type of the instance.	hash
Bytes	long	The number of bytes that are occupied by the key.	12345
Prefix	string	The prefix of the key.	task_
Count	long	The number of elements in the key.	127
BigKeysOfNum	array<object>	The details of the large keys. The returned large keys are sorted in descending order based on the number of keys.
KeyInfo	object
Type	string	The data type of the instance.	hash
Db	integer	The database name.	0
ExpirationTimeMillis	long	The time when the key expires. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC. A value of 0 indicates that the key never expires.	1596256542547
Key	string	The key name.	task_x****
Encoding	string	The data type of the key.	hashtable
Bytes	long	The number of bytes that are occupied by the key.	12345
NodeId	string	The ID of the data node on the instance.	r-x****-db-0
Count	long	The number of elements in the key.	127
UnexBigKeysOfBytes	array<object>	The details of permanent keys. The returned keys are sorted in descending order based on the number of bytes occupied by the keys.
KeyInfo	object
Type	string	The data type of the instance.	hash
Db	integer	The database name.	0
ExpirationTimeMillis	long	The time when the key expires. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC. A value of 0 indicates that the key never expires.	1596256542547
Key	string	The key name.	task_x****
Encoding	string	The data type of the key.	hashtable
Bytes	long	The number of bytes that are occupied by the key.	12345
NodeId	string	The ID of the data node on the instance.	r-x****-db-0
Count	long	The number of elements in the key.	127
UnexBigKeysOfNum	array<object>	The details of permanent keys. The returned keys are sorted in descending order based on the number of keys.
KeyInfo	object
Type	string	The data type of the instance.	hash
Db	integer	The database name.	0
ExpirationTimeMillis	long	The time when the key expires. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC. A value of 0 indicates that the key never expires.	1596256542547
Key	string	The key name.	task_x****
Encoding	string	The data type of the key.	hashtable
Bytes	long	The number of bytes that are occupied by the key.	12345
NodeId	string	The ID of the data node on the instance.	r-x****-db-0
Count	long	The number of elements in the key.	127
InstanceId	string	The instance ID.	r-bp18ff4a195d****
NodeId	string	The ID of the data node on the instance.	r-x****-db-0
ExpiryKeysLevelCount	array<object>	The statistics of the keys that have expired.
ExpiryLevel	object
AnalysisTs	long	The time when the cache analysis task was complete. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.	1717469347000
Level	integer	The expiration level. Valid values: 0: The key never expires. 1: The key has expired. 2: The key has expired for 0 to 1 hour. 3: The key has expired for 1 to 3 hours. 4: The key has expired for 3 to 12 hours. 5: The key has expired for 12 to 24 hours. 6: The key has expired for one to two days. 7: The key has expired for three to seven days. 8: The key has expired for more than seven days.	0
TotalBytes	long	The number of bytes occupied by the keys that have expired.	8064
TotalKeys	long	The total number of the keys that have expired.	62
Code	string	The HTTP status code returned.	200
Success	string	Indicates whether the request was successful. Valid values: true false	true

Examples

Sample success responses

JSONformat

{
  "Message": "Successful",
  "RequestId": "B6D17591-B48B-4D31-9CD6-9B9796B2****",
  "Data": {
    "TaskState": "BACKUP",
    "JobId": "sf79-sd99-sa37-****",
    "Message": "Successful",
    "BigKeys": {
      "KeyInfo": [
        {
          "Type": "hash",
          "Db": 0,
          "ExpirationTimeMillis": 1596256542547,
          "Key": "task_x****",
          "Encoding": "hashtable",
          "Bytes": 12345,
          "NodeId": "r-x****-db-0",
          "Count": 127
        }
      ]
    },
    "KeyPrefixes": {
      "Prefix": [
        {
          "KeyNum": 123,
          "Type": "hash",
          "Bytes": 12345,
          "Prefix": "task_",
          "Count": 127
        }
      ]
    },
    "BigKeysOfNum": {
      "KeyInfo": [
        {
          "Type": "hash",
          "Db": 0,
          "ExpirationTimeMillis": 1596256542547,
          "Key": "task_x****",
          "Encoding": "hashtable",
          "Bytes": 12345,
          "NodeId": "r-x****-db-0",
          "Count": 127
        }
      ]
    },
    "UnexBigKeysOfBytes": {
      "KeyInfo": [
        {
          "Type": "hash",
          "Db": 0,
          "ExpirationTimeMillis": 1596256542547,
          "Key": "task_x****",
          "Encoding": "hashtable",
          "Bytes": 12345,
          "NodeId": "r-x****-db-0",
          "Count": 127
        }
      ]
    },
    "UnexBigKeysOfNum": {
      "KeyInfo": [
        {
          "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",
    "ExpiryKeysLevelCount": {
      "ExpiryLevel": [
        {
          "AnalysisTs": 1717469347000,
          "Level": 0,
          "TotalBytes": 8064,
          "TotalKeys": 62
        }
      ]
    }
  },
  "Code": "200",
  "Success": "true"
}

Error codes

HTTP status code	Error code	Error message
400	InvalidParams	The request parameters are invalid.
403	NoPermission	You are not authorized to do this action.

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

Change history

Change time	Summary of changes	Operation
2024-06-05	The Error code has changed. The response structure of the API has changed	View Change Details
2023-03-30	The Error code has changed. The response structure of the API has changed	View Change Details