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

创建大key分析任务

功能介绍

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

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

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

instance_id

是

String

实例ID。

请求参数

无

响应参数

状态码： 200

表2 响应Body参数

参数

参数类型

描述

id

String

大key分析记录ID。

instance_id

String

实例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"（创建分析任务时此值为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。

size

Long

Key的value大小。

unit

String

表示key的单位。count：key的数量，byte：key的大小。

状态码： 400

表4 响应Body参数

参数

参数类型

描述

error_msg

String

错误信息。

最大长度：1024

error_code

String

错误码。

最大长度：9

error_ext_msg

String

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

最大长度：1024

状态码： 401

表5 响应Body参数

参数

参数类型

描述

error_msg

String

错误信息。

最大长度：1024

error_code

String

错误码。

最大长度：9

error_ext_msg

String

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

最大长度：1024

状态码： 403

表6 响应Body参数

参数

参数类型

描述

error_msg

String

错误信息。

最大长度：1024

error_code

String

错误码。

最大长度：9

error_ext_msg

String

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

最大长度：1024

状态码： 404

表7 响应Body参数

参数

参数类型

描述

error_msg

String

错误信息。

最大长度：1024

error_code

String

错误码。

最大长度：9

error_ext_msg

String

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

最大长度：1024

状态码： 500

表8 响应Body参数

参数

参数类型

描述

error_msg

String

错误信息。

最大长度：1024

error_code

String

错误码。

最大长度：9

error_ext_msg

String

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

最大长度：1024

请求示例

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

内部服务错误。

错误码

请参见错误码。

父主题： 缓存分析