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.
- You can call this operation to analyze the data structures of ApsaraDB for Redis and the following self-developed data structures of Tair: 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.
Debugging
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:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level,
All Resourcesis 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:CreateCacheAnalysisJob | create | *All Resources * |
| 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.
| 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 parameters
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
}
]
},
"InstanceId": "r-bp18ff4a195d****",
"NodeId": "r-x****-db-0"
},
"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 |
|---|---|---|
| 2023-07-06 | The Error code has changed. The request parameters of the API has changed | View Change Details |