文档首页/ 分布式缓存服务 DCS/ API参考（巴黎区域）/ API V2（推荐）/ 缓存分析/ 查询热key分析任务列表
更新时间：2023-12-13 GMT+08:00
查看PDF
分享

查询热key分析任务列表

功能介绍

查询热key分析历史记录。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

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

instance_id

是

String

实例ID。
表2 Query参数

参数

是否必选

参数类型

描述

offset

否

Integer

偏移量，表示从此偏移量开始查询， offset大于等于0。

limit

否

Integer

每页显示的条目数量。

status

否

String

分析任务状态。

枚举值：

  • 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（此ID对应“查询大key/热key分析详情”参数中的任务ID）。

status

String

分析任务状态。

枚举值：

  • 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

错误信息。

最大长度：1024

error_code

String

错误码。

最大长度：9

error_ext_msg

String

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

最大长度：1024

状态码： 401

表6 响应Body参数

参数

参数类型

描述

error_msg

String

错误信息。

最大长度：1024

error_code

String

错误码。

最大长度：9

error_ext_msg

String

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

最大长度：1024

状态码： 403

表7 响应Body参数

参数

参数类型

描述

error_msg

String

错误信息。

最大长度：1024

error_code

String

错误码。

最大长度：9

error_ext_msg

String

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

最大长度：1024

状态码： 404

表8 响应Body参数

参数

参数类型

描述

error_msg

String

错误信息。

最大长度：1024

error_code

String

错误码。

最大长度：9

error_ext_msg

String

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

最大长度：1024

状态码： 500

表9 响应Body参数

参数

参数类型

描述

error_msg

String

错误信息。

最大长度：1024

error_code

String

错误码。

最大长度：9

error_ext_msg

String

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

最大长度：1024

请求示例

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

内部服务错误。

错误码

请参见错误码。

父主题： 缓存分析