Analyze Redis Cache with CreateCacheAnalysisJob API - Database Autonomy Service - Alibaba Cloud - Database Autonomy Service

Creates a cache analysis task by calling the CreateCacheAnalysisJob operation.

Operation description

Before you begin:

Use the latest version of the Alibaba Cloud or DAS SDK.
When calling DAS by using the SDK, set the region to cn-shanghai.
Only Redis data structures and the following Tair-developed data structures are supported for analysis: TairString, TairHash, TairGIS, TairBloom, TairDoc, TairCpc, and TairZset. Other Tair-developed data structures are not supported.
If the specifications of the target instance have been changed, backup files generated before the change cannot be analyzed.
Tair ESSD-based instances are not supported.

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:CreateCacheAnalysisJob

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The instance ID of the Redis instance.	r-bp18ff4a195d****
NodeId	string	No	The ID of the data node in the instance. Specify this parameter to query monitoring information of a specific node. Note If you specify the BackupSetId parameter, this parameter is ignored. You can call the DescribeLogicInstanceTopology operation to query node IDs.	r-x****-db-0
BackupSetId	string	No	The ID of the backup file. You can call the DescribeBackups operation to obtain the backup file ID. To specify multiple backup file IDs, separate them with commas (,), such as `12345,67890`. If you do not specify this parameter, the system automatically performs a backup and runs cache analysis on the backup file.	12345
Separators	string	No	The delimiters used to identify key prefixes. You do not need to specify this parameter if the default delimiters `:;,_-+@=\|#` are used.	&

Response elements

Element	Type	Description	Example
	object
Message	string	The returned message. Note If the request is successful, Successful is returned. If the request fails, an error message such as an error code is returned.	Successful
RequestId	string	The request ID.	B6D17591-B48B-4D31-9CD6-9B9796B2****
Data	object	The details.
TaskState	string	The status of the cache analysis task. Valid values: BACKUP: The system is performing a backup. ANALYZING: The system is analyzing the backup file. FINISHED: The analysis is complete. FAILED: An error occurred.	BACKUP
JobId	string	The ID of query cache analysis task. Note You can use this parameter to query query cache analysis task. Because creating a cache analysis task takes some time, the analysis result is not immediately returned when you call this operation. Use this parameter together with the DescribeCacheAnalysisJob operation to query the analysis result.	sf79-sd99-sa37-****
Message	string	The returned message. Note If the request is successful, Successful is returned. If the request fails, an error message such as an error code is returned.	Successful
BigKeys	object
KeyInfo	array<object>	The details of big keys, sorted in descending order by the number of bytes occupied by the key.
	object
Type	string	The Redis data structure type.	hash
Db	integer	The database name.	0
ExpirationTimeMillis	integer	The expiration time of the key. Unit: milliseconds (ms). A value of 0 indicates that the key does not expire.	1596256542547
Key	string	The name of the key.	task_x****
Encoding	string	The internal data type of the key.	hashtable
Bytes	integer	The number of bytes occupied by the key.	12345
NodeId	string	The ID of the data node in 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 in the instance.	r-x****-db-0
Code	string	The returned status code.	200
Success	string	Indicates whether the request is successful. Valid values: true: The request is successful. false: The request failed.	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
        }
      ]
    },
    "InstanceId": "r-bp18ff4a195d****",
    "NodeId": "r-x****-db-0"
  },
  "Code": "200",
  "Success": "true"
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParams	The request parameters are invalid.	The request parameters are invalid.
403	NoPermission	You are not authorized to do this action.	You do not have the permissions to perform this operation.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.