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

Creates 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 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.
Analyzes the data structures of ApsaraDB for Redis and the following self-developed Tair data structures: TairString, TairHash, TairGIS, TairBloom, TairDoc, TairCpc, and TairZset. Other self-developed Tair data structures are not supported.
If the specifications of the database instance that you want to analyze are changed, the backup file generated before the specification change cannot be analyzed.
Tair ESSD/SSD-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 ID of the ApsaraDB for Redis instance.	r-bp18ff4a195d****
NodeId	string	No	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.	r-x****-db-0
BackupSetId	string	No	The ID of the backup file. You can call the DescribeBackups operation to query the ID. If you need to specify multiple backup file IDs, separate them with commas (,). For example, you can set this parameter to `12345,67890`. If you do not specify this parameter, the system automatically backs up the task and performs cache analysis on the backup file.	12345
Separators	string	No	The delimiters used to identify the prefixes of keys. You do not need to specify this parameter if one or more of the following default delimiters are used: `: ; , _ - + @ = \| #`	&

Response elements

Element	Type	Description	Example
	object	The response parameters.
Message	string	The returned message. Note If the request was successful, Successful is returned. If the request failed, an error message such as an error code is returned.	Successful
RequestId	string	The request ID.	B6D17591-B48B-4D31-9CD6-9B9796B2****
Data	object	The detailed information.
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. Note This parameter can be used to query a specific 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 call the DescribeCacheAnalysisJob operation to query the analysis results of the specified cache analysis task.	sf79-sd99-sa37-****
Message	string	The returned message. Note If the request was successful, Successful is returned. If the request failed, an error message such as an error code is returned.	Successful
BigKeys	object
KeyInfo	array<object>	The number of elements in the key.
	object
Type	string	The data type of the ApsaraDB for Redis instance.	hash
Db	integer	The name of the database.	0
ExpirationTimeMillis	integer	The expiration period of the key. Unit: milliseconds. A value of 0 indicates that the key does not expire.	1596256542547
Key	string	The name of the key.	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
Code	string	The HTTP status code returned.	200
Success	string	Indicates whether the request was successful. Valid values: true: The request was 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.
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.