文档首页> 分布式缓存服务 DCS> API参考（巴黎区域）> API V2（推荐）> 实例诊断> 查询指定诊断报告
更新时间：2023-12-13 GMT+08:00
查看PDF

查询指定诊断报告

功能介绍

通过报告ID查询诊断报告的详细信息。

URI

GET /v2/{project_id}/diagnosis/{report_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

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

report_id

是

String

诊断报告ID。

请求参数

无

响应参数

状态码： 200

表2 响应Body参数

参数

参数类型

描述

abnormal_item_sum

Integer

诊断结果为异常的诊断项总数。

failed_item_sum

Integer

诊断失败的诊断项总数。

diagnosis_node_report_list

Array of DiagnosisNodeReport objects

节点诊断报告列表。
表3 DiagnosisNodeReport

参数

参数类型

描述

node_ip

String

节点IP。例如：192.168.0.234:6379。

az_code

String

节点所在可用区Code。

group_name

String

节点所在分片的名称。

abnormal_sum

Integer

诊断结果为异常的诊断项总数。

failed_sum

Integer

诊断失败的诊断项总数。

role

String

节点角色。

枚举值：

  • master

  • slave

diagnosis_dimension_list

Array of DiagnosisDimension objects

诊断维度列表。

command_time_taken_list

CommandTimeTakenList object

命令耗时统计列表。
表4 DiagnosisDimension

参数

参数类型

描述

name

String

诊断维度名称。

枚举值：

  • network

  • storage

  • load

abnormal_num

Integer

诊断结果为异常的诊断项总数。

failed_num

Integer

诊断失败的诊断项总数。

diagnosis_item_list

Array of DiagnosisItem objects

诊断项列表。
表5 DiagnosisItem

参数

参数类型

描述

name

String

诊断项名称。

枚举值：

  • connection_num

  • rx_controlled

  • persistence

  • centralized_expiration

  • inner_memory_fragmentation

  • time_consuming_commands

  • hit_ratio

  • memory_usage

  • cpu_usage

cause_ids

Array of ConclusionItem objects

原因ID列表，ID说明请见文档附录中的实例诊断ID说明。

impact_ids

Array of ConclusionItem objects

影响ID列表，ID说明请见文档附录中的实例诊断ID说明。

advice_ids

Array of ConclusionItem objects

建议ID列表，ID说明请见文档附录中的实例诊断ID说明。

result

String

诊断结果。

枚举值：

  • failed

  • abnormal

  • normal
表6 ConclusionItem

参数

参数类型

描述

id

Integer

结论ID。

params

Map<String,String>

结论参数。
表7 CommandTimeTakenList

参数

参数类型

描述

total_num

Integer

执行命令的总次数。

total_usec_sum

Double

执行命令的总耗时。

result

String

命令耗时统计结果。

枚举值：

  • succeed

  • failed

command_list

Array of CommandTimeTaken objects

命令耗时统计。
表8 CommandTimeTaken

参数

参数类型

描述

calls_sum

Integer

调用次数。

usec_sum

Double

耗时总数。

command_name

String

命令名称。

per_usec

String

耗时占比。

average_usec

Double

每次调用平均耗时。

状态码： 400

表9 响应Body参数

参数

参数类型

描述

error_msg

String

错误信息。

最大长度：1024

error_code

String

错误码。

最大长度：9

error_ext_msg

String

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

最大长度：1024

状态码： 500

表10 响应Body参数

参数

参数类型

描述

error_msg

String

错误信息。

最大长度：1024

error_code

String

错误码。

最大长度：9

error_ext_msg

String

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

最大长度：1024

请求示例

无

响应示例

状态码： 200

查询指定报告成功。

{
  "abnormal_item_sum" : 1,
  "failed_item_sum" : 0,
  "diagnosis_node_report_list" : [ {
    "group_name" : "group-0",
    "az_code" : "region01",
    "node_ip" : "192.168.0.170:6379",
    "abnormal_sum" : 1,
    "failed_sum" : 0,
    "role" : "master",
    "command_time_taken_list" : {
      "command_list" : [ {
        "calls_sum" : 329,
        "usec_sum" : 20.732,
        "command_name" : "info",
        "per_usec" : "68.61%",
        "average_usec" : 0.063
      }, {
        "calls_sum" : 1788,
        "usec_sum" : 1.787,
        "command_name" : "ping",
        "per_usec" : "5.91%",
        "average_usec" : 0.001
      }, {
        "calls_sum" : 2,
        "usec_sum" : 0.025,
        "command_name" : "config",
        "per_usec" : "0.08%",
        "average_usec" : 0.013
      }, {
        "calls_sum" : 60,
        "usec_sum" : 0.186,
        "command_name" : "slowlog",
        "per_usec" : "0.62%",
        "average_usec" : 0.003
      }, {
        "calls_sum" : 1764,
        "usec_sum" : 7.485,
        "command_name" : "publish",
        "per_usec" : "24.77%",
        "average_usec" : 0.004
      } ],
      "result" : "succeed",
      "error_code" : null,
      "total_num" : 5,
      "total_usec_sum" : 30.215
    },
    "diagnosis_dimension_list" : [ {
      "name" : "load",
      "abnormal_num" : 0,
      "failed_num" : 0,
      "diagnosis_item_list" : [ {
        "name" : "cpu_usage",
        "result" : "normal",
        "cause_ids" : null,
        "impact_ids" : null,
        "advice_ids" : null,
        "error_code" : null
      }, {
        "name" : "time_consuming_commands",
        "result" : "normal",
        "cause_ids" : null,
        "impact_ids" : null,
        "advice_ids" : null,
        "error_code" : null
      } ]
    }, {
      "name" : "storage",
      "abnormal_num" : 1,
      "failed_num" : 0,
      "diagnosis_item_list" : [ {
        "name" : "inner_memory_fragmentation",
        "result" : "normal",
        "cause_ids" : [ {
          "id" : 7,
          "params" : null
        } ],
        "impact_ids" : [ {
          "id" : 3,
          "params" : null
        } ],
        "advice_ids" : [ {
          "id" : 4,
          "params" : null
        } ],
        "error_code" : null
      }, {
        "name" : "persistence",
        "result" : "normal",
        "cause_ids" : null,
        "impact_ids" : null,
        "advice_ids" : null,
        "error_code" : null
      }, {
        "name" : "centralized_expiration",
        "result" : "normal",
        "cause_ids" : null,
        "impact_ids" : null,
        "advice_ids" : null,
        "error_code" : null
      }, {
        "name" : "memory_usage",
        "result" : "normal",
        "cause_ids" : null,
        "impact_ids" : null,
        "advice_ids" : null,
        "error_code" : null
      }, {
        "name" : "hit_ratio",
        "result" : "normal",
        "cause_ids" : null,
        "impact_ids" : null,
        "advice_ids" : null,
        "error_code" : null
      } ]
    }, {
      "name" : "network",
      "abnormal_num" : 0,
      "failed_num" : 0,
      "diagnosis_item_list" : [ {
        "name" : "connection_num",
        "result" : "normal",
        "cause_ids" : null,
        "impact_ids" : null,
        "advice_ids" : null,
        "error_code" : null
      }, {
        "name" : "rx_controlled",
        "result" : "normal",
        "cause_ids" : null,
        "impact_ids" : null,
        "advice_ids" : null,
        "error_code" : null
      } ]
    } ]
  } ]
}

状态码

状态码

描述

200

查询指定报告成功。

400

非法请求。

500

内部服务错误。

错误码

请参见错误码。

父主题： 实例诊断