文档首页/分布式缓存服务 DCS/API参考（吉隆坡区域）/API V2（推荐）/缓存分析/查询热key分析任务列表
更新时间：2025-11-14 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询热key分析任务列表

功能介绍

查询热key分析历史记录。

URI

GET /v2/{project_id}/instances/{instance_id}/hotkey-tasks

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

项目ID。获取方法请参见获取项目ID。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

instance_id

是

String

参数解释：

实例ID。可通过DCS控制台进入实例详情界面查看。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

表2 Query参数

参数

是否必选

参数类型

描述

offset

否

Integer

参数解释：

偏移量，表示生成的列表从此偏移量开始显示，例如偏移量为3时，生成的列表从第4条开始。

约束限制：

不涉及。

取值范围：

大于等于0。

默认取值：

0

limit

否

Integer

参数解释：

每页显示的条目数量。

约束限制：

不涉及。

取值范围：

1-1000

默认取值：

10

status

否

String

参数解释：

过期key扫描任务的状态。

约束限制：

不涉及。

取值范围：

  • waiting：待处理。

  • running：处理中。

  • success：成功。

  • failed：失败。

默认取值：

不涉及。

请求参数

无

响应参数

状态码：200

表3 响应Body参数

参数

参数类型

描述

instance_id

String

参数解释：

实例ID。

取值范围：

不涉及。

count

Integer

参数解释：

热key分析的次数。

取值范围：

不涉及。

records

Array of RecordsResponse objects

参数解释：

热key分析记录列表。

取值范围：

不涉及。

表4 RecordsResponse

参数

参数类型

描述

id

String

参数解释：

分析操作的任务ID。

取值范围：

不涉及。

status

String

参数解释：

热key分析任务的状态。

取值范围：

  • waiting：待处理。

  • running：处理中。

  • success：成功。

  • failed：失败。

scan_type

String

参数解释：

分析方式。

取值范围：

  • manual：手动分析。

  • auto：自动分析。

created_at

String

参数解释：

分析任务创建的时间，格式为："2020-06-15T02:21:18.669Z"。

取值范围：

不涉及。

started_at

String

参数解释：

分析任务的开始时间，格式为："2020-06-15T02:21:18.669Z"。

取值范围：

不涉及。

finished_at

String

参数解释：

分析任务的结束时间，式为："2020-06-15T02:21:18.669Z"。

取值范围：

不涉及。

状态码：400

表5 响应Body参数

参数

参数类型

描述

error_msg

String

参数解释：

错误信息。

取值范围：

不涉及。

error_code

String

参数解释：

错误码。

取值范围：

请参见错误码。

error_ext_msg

String

参数解释：

扩展错误信息（暂未使用，赋值为null）。

取值范围：

不涉及。

状态码：401

表6 响应Body参数

参数

参数类型

描述

error_msg

String

参数解释：

错误信息。

取值范围：

不涉及。

error_code

String

参数解释：

错误码。

取值范围：

请参见错误码。

error_ext_msg

String

参数解释：

扩展错误信息（暂未使用，赋值为null）。

取值范围：

不涉及。

状态码：403

表7 响应Body参数

参数

参数类型

描述

error_msg

String

参数解释：

错误信息。

取值范围：

不涉及。

error_code

String

参数解释：

错误码。

取值范围：

请参见错误码。

error_ext_msg

String

参数解释：

扩展错误信息（暂未使用，赋值为null）。

取值范围：

不涉及。

状态码：404

表8 响应Body参数

参数

参数类型

描述

error_msg

String

参数解释：

错误信息。

取值范围：

不涉及。

error_code

String

参数解释：

错误码。

取值范围：

请参见错误码。

error_ext_msg

String

参数解释：

扩展错误信息（暂未使用，赋值为null）。

取值范围：

不涉及。

状态码：500

表9 响应Body参数

参数

参数类型

描述

error_msg

String

参数解释：

错误信息。

取值范围：

不涉及。

error_code

String

参数解释：

错误码。

取值范围：

请参见错误码。

error_ext_msg

String

参数解释：

扩展错误信息（暂未使用，赋值为null）。

取值范围：

不涉及。

请求示例

GET https://{dcs_endpoint}/v2/a4d31cb6-3d72-4fdc-8ec9-6e3a41e47f71/instances/5560df16-cebf-4473-95c4-d1b573c16e79/hotkey-tasks

响应示例

状态码：200

查询热key分析任务列表。

{
  "instance_id" : "5f9057b5-c330-4ee2-8138-7e69896eeec3",
  "count" : 1,
  "records" : [ {
    "id" : "858ee14c-2271-4489-8b82-7bda7459ae3e",
    "scan_type" : "manual",
    "status" : "success",
    "created_at" : "2020-06-15T02:21:18.669Z",
    "started_at" : "2020-06-15T02:21:23.534Z",
    "finished_at" : "2020-06-15T02:21:25.588Z"
  } ]
}

状态码：400

非法请求。

{
  "error_code" : "DCS.4922",
  "error_msg" : "Does not support hotkey analyze."
}

状态码

状态码

描述

200

查询热key分析任务列表。

400

非法请求。

401

认证信息非法。

403

请求被拒绝访问。

404

所请求的资源不存在。

500

内部服务错误。

错误码

请参见错误码。

父主题：缓存分析