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

创建大key分析任务

功能介绍

为Redis实例创建大key分析任务。

URI

POST /v2/{project_id}/instances/{instance_id}/bigkey-task

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

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

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

instance_id

是

String

参数解释：

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

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

请求参数

无

响应参数

状态码：200

表2 响应Body参数

参数

参数类型

描述

id

String

参数解释：

大key分析任务ID。

取值范围：

不涉及。

instance_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"（创建分析任务时此值为null，不返回）。

取值范围：

不涉及。

finished_at

String

参数解释：

分析任务结束时间，格式为："2020-06-15T02:21:18.669Z"（创建分析任务时此值为null，不返回）。

取值范围：

不涉及。

num

Integer

参数解释：

大key的数量。

取值范围：

不涉及。

keys

Array of BigkeysBody objects

参数解释：

大key记录（创建分析任务时此值为null，不返回）。

取值范围：

不涉及。
表3 BigkeysBody

参数

参数类型

描述

name

String

参数解释：

Key名称。

取值范围：

不涉及。

type

String

参数解释：

Key类型。

取值范围：

  • string：字符串类型。

  • list：列表类型。

  • set：集合类型。

  • zset：有序类型。

  • hash：哈希类型。

shard

String

参数解释：

大key所在的分片，仅在实例类型为集群时支持，格式为ip:port。

取值范围：

不涉及。

db

Integer

参数解释：

大key所在的DB。

取值范围：

0-255

size

Long

参数解释：

Key的value大小。

取值范围：

不涉及。

unit

String

参数解释：

表示key的单位。

取值范围：

  • count：key的数量。

  • byte：key的大小。

状态码：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）。

取值范围：

不涉及。

请求示例

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

响应示例

状态码：200

创建大key分析任务成功。

{
  "id" : "858ee14c-2271-4489-8b82-7bda7459ae3e",
  "instance_id" : "5f9057b5-c330-4ee2-8138-7e69896eeec3",
  "status" : "waiting",
  "scan_type" : "manual",
  "created_at" : "2020-06-15T02:21:18.669Z",
  "num" : 0
}

状态码：400

非法请求。

{
  "error_code" : "DCS.4919",
  "error_msg" : "Does not support bigkey analyze."
}

状态码

状态码

描述

200

创建大key分析任务成功。

400

非法请求。

401

认证信息非法。

403

请求被拒绝访问。

404

所请求的资源不存在。

500

内部服务错误。

错误码

请参见错误码。

父主题： 缓存分析