All Products
Search
Document Center

Database Autonomy Service:DescribeCacheAnalysisJobs

Last Updated:Jan 26, 2024

Queries a list of cache analysis tasks.

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 API operations of DAS, you must set the region ID 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:DescribeCacheAnalysisJobsList
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
InstanceIdstringYes

The instance ID.

r-bp18ff4a195d****
StartTimestringYes

The beginning of the time range to query. Set this parameter to a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.

1596177993000
EndTimestringYes

The end of the time range to query. Set this parameter to a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.

Note The end time must be later than the start time.
1596177993001
PageNostringNo

The page number. The value must be an integer that is greater than 0. Default value: 1.

1
PageSizestringNo

The number of entries per page. Default value: 10.

10

Response parameters

ParameterTypeDescriptionExample
object
Messagestring

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
RequestIdstring

The request ID.

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

The list of cache analysis tasks.

Listobject []

The ID of the data node on the instance.

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

The details about the large keys.

Note The sub-parameters of this parameter and the content of the sub-parameters are not returned. To query the detailed information about the cache analysis tasks, call the DescribeCacheAnalysisJob operation.
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_*****
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-****-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
PageNolong

The page number. The value must be an integer that is greater than 0. Default value: 1.

1
PageSizelong

The number of entries per page. Default value: 10.

10
Extrastring

The reserved parameter.

None
Totallong

The total number of entries returned.

4
Codestring

The HTTP status code returned.

200
Successstring

Indicates whether the request was successful. Valid values:

  • true: The request was successful.
  • false: The request failed.
true

Examples

Sample success responses

JSONformat

{
  "Message": "Successful",
  "RequestId": "B6D17591-B48B-4D31-9CD6-9B9796B2****",
  "Data": {
    "List": {
      "CacheAnalysisJob": [
        {
          "TaskState": "BACKUP",
          "JobId": "sf79-sd99-sa37-****",
          "Message": "Successful",
          "BigKeys": {
            "KeyInfo": [
              {
                "Type": "hash",
                "Db": 0,
                "ExpirationTimeMillis": 1596256542547,
                "Key": "task_*****",
                "Encoding": "hashtable",
                "Bytes": 12345,
                "NodeId": "r-****-db-0",
                "Count": 127
              }
            ]
          },
          "InstanceId": "r-bp18ff4a195d****",
          "NodeId": "r-x****-db-0"
        }
      ]
    },
    "PageNo": 1,
    "PageSize": 10,
    "Extra": "None",
    "Total": 4
  },
  "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
No change history