本文导读

功能介绍
调用方法
URI
请求参数
响应参数
请求示例
响应示例
状态码
错误码

展开导读

文档首页/ 分布式缓存服务 DCS/ API参考/ API V2（推荐）/ 离线全量key分析/ 查询离线全量key分析任务列表

查询离线全量key分析任务列表

更新时间：2025-05-20 GMT+08:00

在线调试

CLI示例

查看PDF

功能介绍

查询离线全量key分析任务列表，支持Redis4.0、5.0、6.0版本及Redis企业版。

调用方法

请参见如何调用API。

URI

GET /v2/{project_id}/instances/{instance_id}/offline/key-analysis

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	参数解释：项目ID。获取方法请参见获取项目ID。约束限制：不涉及。取值范围：不涉及。默认取值：不涉及。
instance_id	是	String	参数解释：实例ID。可通过DCS控制台进入实例详情界面查看。约束限制：不涉及。取值范围：不涉及。默认取值：不涉及。

表2 Query参数
参数	是否必选	参数类型	描述
offset	否	Integer	参数解释：偏移量，表示从此偏移量开始查询。约束限制：不涉及。取值范围：大于等于0。默认取值： 0
limit	否	Integer	参数解释：每页显示的条目数量。约束限制：不涉及。取值范围：大于等于0。默认取值： 10
status	否	String	参数解释：离线分析的任务状态。约束限制：不涉及。取值范围： waiting：任务等待中。 running：任务进行中。 success：任务执行成功。 failed：任务执行失败。默认取值：不涉及。

请求参数

无

响应参数

状态码：200

表3 响应Body参数
参数	参数类型	描述
instance_id	String	参数解释：实例ID。取值范围：不涉及。
total	Integer	参数解释：离线全量key分析的总数。取值范围：不涉及。
records	Array of OfflineKeyAnalysisRecord objects	参数解释：离线全量key分析记录列表。

表4 OfflineKeyAnalysisRecord
参数	参数类型	描述
id	String	参数解释：任务执行记录ID（此ID对应“查询离线全量key分析详情”参数中的任务ID）。取值范围：不涉及。
status	String	参数解释：离线分析任务状态。取值范围： waiting：任务等待中。 running：任务进行中。 success：任务执行成功。 failed：任务执行失败。
created_at	String	参数解释：分析任务创建时间。取值范围：不涉及。
started_at	String	参数解释：分析任务开始时间。取值范围：不涉及。
finished_at	String	参数解释：分析任务结束时间。取值范围：不涉及。

状态码：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/{project_id}/instances/{instance_id}/offline/key-analysis

响应示例

状态码：200

查询离线全量key分析任务列表。

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

状态码：400

非法请求。

{
  "error_code" : "DCS.4230",
  "error_msg" : "Does not support offline key analysis."
}

状态码


状态码	描述
200	查询离线全量key分析任务列表。
400	非法请求。
401	认证信息非法。
403	请求被拒绝访问。
404	所请求的资源不存在。
500	内部服务错误。

错误码

请参见错误码。

父主题：离线全量key分析

上一篇：创建离线全量key分析任务

下一篇：查询离线全量key分析详情

意见反馈

文档内容是否对您有帮助？

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！您可在我的云声建议查看反馈及问题处理状态。

系统繁忙，请稍后重试

在使用文档中是否遇到以下问题

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

请至少选择一项反馈信息并填写问题反馈

字符长度不能超过500

直接提交取消

如您有其它疑问，您也可以通过华为云社区问答频道来与我们联系探讨

智能客服提问云社区提问