更新时间:2025-12-29 GMT+08:00

创建实例诊断任务

功能介绍

诊断指定的缓存实例。

URI

POST /v2/{project_id}/instances/{instance_id}/diagnosis

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

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

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

instance_id

String

参数解释

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

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

begin_time

String

参数解释

诊断开始时间。UNIX时间戳,单位毫秒。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

end_time

String

参数解释

诊断结束时间。UNIX时间戳,单位毫秒。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

node_ip_list

Array of strings

参数解释

诊断节点IP列表。默认诊断所有节点。

非读写分离实例查询方法如下:

  • 方法一:参考分布式缓存服务用户指南的“查看实例信息”章节。

  • 方法二:调用查询指定实例接口查询。

读写分离实例查询方法:调用查询分片信息接口。

约束限制

不涉及。

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

report_id

String

参数解释

报告ID。

取值范围

不涉及。

状态码:400

表4 响应Body参数

参数

参数类型

描述

error_msg

String

参数解释

错误信息。

取值范围

不涉及。

error_code

String

参数解释

错误码。

取值范围

请参见错误码

error_ext_msg

String

参数解释

扩展错误信息(暂未使用,赋值为null)。

取值范围

不涉及。

状态码:500

表5 响应Body参数

参数

参数类型

描述

error_msg

String

参数解释

错误信息。

取值范围

不涉及。

error_code

String

参数解释

错误码。

取值范围

请参见错误码

error_ext_msg

String

参数解释

扩展错误信息(暂未使用,赋值为null)。

取值范围

不涉及。

请求示例

创建实例诊断任务,设置诊断的起止时间和需要诊断的节点IP。

POST https://{dcs_endpoint}/v2/{project_id}/instances/{instance_id}/diagnosis

{
  "begin_time" : 1618466522486,
  "end_time" : 1618467122486,
  "node_ip_list" : [ "192.168.0.111" ]
}

响应示例

状态码:200

下发诊断任务成功。

{
  "report_id" : "716c9cca-8ce2-4a89-b3db-7cee209d6379"
}

状态码

状态码

描述

200

下发诊断任务成功。

400

非法请求。

500

内部服务错误。

错误码

请参见错误码