文档

DescribeCacheAnalysisJob - 查询缓存分析任务详情

更新时间:

调用DescribeCacheAnalysisJob接口,查询缓存分析任务详情。

接口说明

使用该接口需满足以下前提条件:

  • 使用阿里云或 DAS 的 SDK 时,建议使用最新版本。
  • 使用 SDK 调用 DAS 服务时,需要将地域指定为 cn-shanghai。
  • 本接口只适用于 Redis 引擎。
说明 调用本接口可查询实例缓存分析任务中排名前 500 的 Key 信息。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
hdm:DescribeCacheAnalysisJobRead
  • 全部资源
    *

请求参数

名称类型必填描述示例值
InstanceIdstring

实例 ID。

r-bp18ff4a195d****
JobIdstring

缓存分析任务 ID,您可通过调用 CreateCacheAnalysisJob 接口获取返回参数的 JobId。

sf79-sd99-sa37-****

返回参数

名称类型描述示例值
object
Messagestring

请求返回消息。

说明 请求成功时该参数返回 Successful,请求失败时会返回请求异常信息(如错误码等)。
Successful
RequestIdstring

请求 ID。

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

详细信息列表。

TaskStatestring

缓存分析任务的状态:

  • BACKUP:备份中。
  • ANALYZING:分析中。
  • FINISHED:分析完成。
  • FAILED:出现错误。
BACKUP
JobIdstring

缓存分析任务 ID。

sf79-sd99-sa37-****
Messagestring

请求返回消息。

说明 请求成功时该参数返回 Successful,请求失败时会返回请求异常信息(如错误码等)。
Successful
BigKeysobject []

大 Key 详细信息,根据 Key 占用字节数降序排列。

Typestring

Redis 数据结构类型。

hash
Dbinteger

数据库名称。

0
ExpirationTimeMillislong

Key 过期时间,格式为 Unix 时间戳,单位为毫秒(ms),0 表示不过期。

1596256542547
Keystring

Key 的名称。

task_x****
Encodingstring

Key 内部数据类型。

hashtable
Byteslong

Key 占用字节数。

12345
NodeIdstring

实例的数据节点 ID。

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

Key 的元素个数。

127
KeyPrefixesobject []

Key 前缀列表。

KeyNumlong

该前缀 Key 的数量。

123
Typestring

Redis 数据结构类型。

hash
Byteslong

Key 占用字节数。

12345
Prefixstring

Key 的前缀。

task_
Countlong

Key 的元素个数。

127
BigKeysOfNumobject []

大 Key 详细信息,根据 Key 数量降序排列。

Typestring

Redis 数据结构类型。

hash
Dbinteger

数据库名称。

0
ExpirationTimeMillislong

Key 过期时间,格式为 Unix 时间戳,单位为毫秒(ms),0 表示不过期。

1596256542547
Keystring

Key 的名称。

task_x****
Encodingstring

Key 内部数据类型。

hashtable
Byteslong

Key 占用字节数。

12345
NodeIdstring

实例的数据节点 ID。

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

Key 的元素个数。

127
UnexBigKeysOfBytesobject []

永不过期 Key 的详细信息,根据 Key 占用字节数降序排列。

Typestring

Redis 数据结构类型。

hash
Dbinteger

数据库名称。

0
ExpirationTimeMillislong

Key 过期时间,格式为 Unix 时间戳,单位为毫秒(ms),0 表示不过期。

1596256542547
Keystring

Key 的名称。

task_x****
Encodingstring

Key 内部数据类型。

hashtable
Byteslong

Key 占用字节数。

12345
NodeIdstring

实例的数据节点 ID

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

Key 的元素个数。

127
UnexBigKeysOfNumobject []

永不过期 Key 的详细信息,根据 Key 数量降序排列。

Typestring

Redis 数据结构类型。

hash
Dbinteger

数据库名称。

0
ExpirationTimeMillislong

Key 过期时间,格式为 Unix 时间戳,单位为毫秒(ms),0 表示不过期。

1596256542547
Keystring

Key 的名称。

task_x****
Encodingstring

Key 内部数据类型。

hashtable
Byteslong

Key 占用字节数。

12345
NodeIdstring

实例的数据节点 ID。

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

Key 的元素个数。

127
InstanceIdstring

实例 ID。

r-bp18ff4a195d****
NodeIdstring

实例的数据节点 ID。

r-x****-db-0
ExpiryKeysLevelCountobject []

按过期时间分类的 Key 统计信息。

AnalysisTslong

分析完成的时间,格式为 Unix 时间戳,单位为毫秒(ms)。

1717469347000
Levelinteger

过期时间级别。取值:

  • 0:不过期。
  • 1:已过期。
  • 2:过期 0~1 小时。
  • 3:过期 1~3 小时。
  • 4:过期 3~12 小时。
  • 5:过期 12~24 小时。
  • 6:过期 1~2 天。
  • 7:过期 3~7 天。
  • 8:过期超过 7 天。
0
TotalByteslong

按过期时间分类统计的 Key 占用的字节数。

8064
TotalKeyslong

按过期时间分类统计的 Key 总数。

62
Codestring

返回的状态码。

200
Successstring

请求是否执行成功:

  • true:执行成功。
  • false:执行失败。
true

示例

正常返回示例

JSON格式

{
  "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",
    "ExpiryKeysLevelCount": {
      "ExpiryLevel": [
        {
          "AnalysisTs": 1717469347000,
          "Level": 0,
          "TotalBytes": 8064,
          "TotalKeys": 62
        }
      ]
    }
  },
  "Code": "200",
  "Success": "true"
}

错误码

HTTP status code错误码错误信息描述
400InvalidParamsThe request parameters are invalid.请求参数错误
403NoPermissionYou are not authorized to do this action.没有权限执行该操作

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2024-06-05OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
出参OpenAPI 返回结构发生变更
2023-03-30OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    新增错误码:400
出参OpenAPI 返回结构发生变更
  • 本页导读 (1)