All Products
Search
Document Center

Database Autonomy Service:DescribeCacheAnalysisJob

Last Updated:Jan 26, 2024

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 operations of DAS, you must set the region to cn-shanghai.
  • This operation is applicable only to ApsaraDB for Redis.

Debugging

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

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.
OperationAccess levelResource typeCondition keyAssociated operation
hdm:DescribeCacheAnalysisJobRead
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
InstanceIdstringYes

The ID of the instance.

r-bp18ff4a195d****
JobIdstringYes

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

ParameterTypeDescriptionExample
object
Messagestring

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
RequestIdstring

The ID of the request.

B6D17591-B48B-4D31-9CD6-9B9796B2****
Dataobject

The details of the task.

TaskStatestring

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
JobIdstring

The ID of the cache analysis task.

sf79-sd99-sa37-****
Messagestring

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
BigKeysobject []

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.

Typestring

The data type of the instance.

hash
Dbinteger

The name of the database.

0
ExpirationTimeMillislong

The expiration period of the key. Unit: milliseconds. A value of 0 indicates that the key does not expire.

1596256542547
Keystring

The name of the key.

task_x****
Encodingstring

The data type of the key.

hashtable
Byteslong

The number of bytes that are occupied by the key.

12345
NodeIdstring

The ID of the data node on the instance.

r-x****-db-0
Countlong

The number of elements in the key.

127
KeyPrefixesobject []

The prefixes of the keys.

KeyNumlong

The number of keys that contain the prefix.

123
Typestring

The data type of the instance.

hash
Byteslong

The number of bytes that are occupied by the key.

12345
Prefixstring

The prefix of the key.

task_
Countlong

The number of elements in the key.

127
BigKeysOfNumobject []

The details of the large keys. The returned large keys are sorted in descending order based on the number of keys.

Typestring

The data type of the instance.

hash
Dbinteger

The name of the database.

0
ExpirationTimeMillislong

The expiration period of the key. Unit: milliseconds. A value of 0 indicates that the key does not expire.

1596256542547
Keystring

The name of the key.

task_x****
Encodingstring

The data type of the key.

hashtable
Byteslong

The number of bytes that are occupied by the key.

12345
NodeIdstring

The ID of the data node on the instance.

r-x****-db-0
Countlong

The number of elements in the key.

127
UnexBigKeysOfBytesobject []

The details of permanent keys. The returned keys are sorted in descending order based on the number of bytes occupied by the keys.

Typestring

The data type of the instance.

hash
Dbinteger

The name of the database.

0
ExpirationTimeMillislong

The expiration period of the key. Unit: milliseconds. A value of 0 indicates that the key does not expire.

1596256542547
Keystring

The name of the key.

task_x****
Encodingstring

The data type of the key.

hashtable
Byteslong

The number of bytes that are occupied by the key.

12345
NodeIdstring

The ID of the data node on the instance.

r-x****-db-0
Countlong

The number of elements in the key.

127
UnexBigKeysOfNumobject []

The details of permanent keys. The returned keys are sorted in descending order based on the number of keys.

Typestring

The data type of the instance.

hash
Dbinteger

The name of the database.

0
ExpirationTimeMillislong

The expiration period of the key. Unit: milliseconds. A value of 0 indicates that the key does not expire.

1596256542547
Keystring

The name of the key.

task_x****
Encodingstring

The data type of the key.

hashtable
Byteslong

The number of bytes that are occupied by the key.

12345
NodeIdstring

The ID of the data node on the instance.

r-x****-db-0
Countlong

The number of elements in the key.

127
InstanceIdstring

The instance ID.

r-bp18ff4a195d****
NodeIdstring

The ID of the data node on the instance.

r-x****-db-0
Codestring

The HTTP status code returned.

200
Successstring

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"
  },
  "Code": "200",
  "Success": "true"
}

Error codes

HTTP status codeError codeError message
400InvalidParamsThe request parameters are invalid.
403NoPermissionYou are not authorized to do this action.

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

Change history

Change timeSummary of changesOperation
2023-03-30The Error code has changed. The response structure of the API has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    Added Error Codes: 400
Output ParametersThe response structure of the API has changed.