Use DescribeCacheAnalysisJob to query cache analysis task details - 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.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

hdm:DescribeCacheAnalysisJob

get

*All Resource

*

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 elements

Element	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	object
KeyInfo	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.
	object
Type	string	The data type of the instance.	hash
Db	integer	The database name.	0
ExpirationTimeMillis	integer	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	integer	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	integer	The number of elements in the key.	127
KeyPrefixes	object
Prefix	array<object>	The prefixes of the keys.
	object
KeyNum	integer	The number of keys that contain the prefix.	123
Type	string	The data type of the instance.	hash
Bytes	integer	The number of bytes that are occupied by the key.	12345
Prefix	string	The prefix of the key.	task_
Count	integer	The number of elements in the key.	127
BigKeysOfNum	object
KeyInfo	array<object>	The details of the large keys. The returned large keys are sorted in descending order based on the number of keys.
	object
Type	string	The data type of the instance.	hash
Db	integer	The database name.	0
ExpirationTimeMillis	integer	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	integer	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	integer	The number of elements in the key.	127
UnexBigKeysOfBytes	object
KeyInfo	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.
	object
Type	string	The data type of the instance.	hash
Db	integer	The database name.	0
ExpirationTimeMillis	integer	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	integer	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	integer	The number of elements in the key.	127
UnexBigKeysOfNum	object
KeyInfo	array<object>	The details of permanent keys. The returned keys are sorted in descending order based on the number of keys.
	object
Type	string	The data type of the instance.	hash
Db	integer	The database name.	0
ExpirationTimeMillis	integer	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	integer	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	integer	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	object
ExpiryLevel	array<object>	The statistics of the keys that have expired.
	object
AnalysisTs	integer	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	integer	The number of bytes occupied by the keys that have expired.	8064
TotalKeys	integer	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

Success response

JSON format

{
  "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	Description
400	InvalidParams	The request parameters are invalid.
403	NoPermission	You are not authorized to do this action.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.