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

设置热key自动分析配置

功能介绍

设置热key自动分析配置。

URI

PUT /v2/{project_id}/instances/{instance_id}/hotkey/autoscan

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

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

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

instance_id

是

String

参数解释：

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

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

enable_auto_scan

是

Boolean

参数解释：

是否开启缓存分析定时任务。

约束限制：

不涉及。

取值范围：

  • true

  • false

默认取值：

不涉及。

schedule_at

是

Array of strings

参数解释：

每日缓存分析时间，时间格式为21:00，时间为UTC时间。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

响应参数

状态码：200

表3 响应Body参数

参数

参数类型

描述

instance_id

String

参数解释：

实例ID。

取值范围：

不涉及。

enable_auto_scan

Boolean

参数解释：

是否开启缓存分析定时任务。

取值范围：

  • true

  • false

schedule_at

Array of strings

参数解释：

每日分析时间，时间格式为21:00，时间为UTC时间。

取值范围：

不涉及。

updated_at

String

参数解释：

配置更新时间，时间格式为2020-06-15T02:21:18.669Z。

取值范围：

不涉及。

状态码：400

表4 响应Body参数

参数

参数类型

描述

error_msg

String

参数解释：

错误信息。

取值范围：

不涉及。

error_code

String

参数解释：

错误码。

取值范围：

请参见错误码。

error_ext_msg

String

参数解释：

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

取值范围：

不涉及。

状态码：401

表5 响应Body参数

参数

参数类型

描述

error_msg

String

参数解释：

错误信息。

取值范围：

不涉及。

error_code

String

参数解释：

错误码。

取值范围：

请参见错误码。

error_ext_msg

String

参数解释：

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

取值范围：

不涉及。

状态码：403

表6 响应Body参数

参数

参数类型

描述

error_msg

String

参数解释：

错误信息。

取值范围：

不涉及。

error_code

String

参数解释：

错误码。

取值范围：

请参见错误码。

error_ext_msg

String

参数解释：

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

取值范围：

不涉及。

状态码：404

表7 响应Body参数

参数

参数类型

描述

error_msg

String

参数解释：

错误信息。

取值范围：

不涉及。

error_code

String

参数解释：

错误码。

取值范围：

请参见错误码。

error_ext_msg

String

参数解释：

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

取值范围：

不涉及。

状态码：500

表8 响应Body参数

参数

参数类型

描述

error_msg

String

参数解释：

错误信息。

取值范围：

不涉及。

error_code

String

参数解释：

错误码。

取值范围：

请参见错误码。

error_ext_msg

String

参数解释：

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

取值范围：

不涉及。

请求示例

设置热key自动分析任务，每日缓存分析时间为21：00。

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

{
  "enable_auto_scan" : true,
  "schedule_at" : [ "21:00" ]
}

响应示例

状态码：200

设置热key自动分析配置成功。

{
  "instance_id" : "5f9057b5-c330-4ee2-8138-7e69896eeec3",
  "enable_auto_scan" : true,
  "schedule_at" : [ "21:00" ],
  "updated_at" : "2020-06-17T02:42:40.793Z"
}

状态码：400

非法请求。

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

状态码

状态码

描述

200

设置热key自动分析配置成功。

400

非法请求。

401

认证信息非法。

403

请求被拒绝访问。

404

所请求的资源不存在。

500

内部服务错误。

错误码

请参见错误码。

父主题： 缓存分析