文档首页/ 数据管理服务 DAS/ API参考/ API(公测中)/ 云DBA/ 获取实例健康诊断报告内容
更新时间:2024-11-01 GMT+08:00
分享

获取实例健康诊断报告内容

功能介绍

获取实例健康诊断报告内容。

调试

您可以在API Explorer中调试该接口。

URI

GET /v3/{project_id}/instances/{instance_id}/get-instance-health-report

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

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

instance_id

String

实例ID。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户token。

X-Language

String

语言。

枚举值:

  • zh-cn
  • en-us
表3 Query参数

参数

是否必选

参数类型

描述

task_id

String

任务ID。

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

success

Boolean

日报诊断是否成功。

start_at

Long

日报诊断区间的起始时间(Unix timestamp),单位:毫秒。

end_at

Long

日报诊断区间的结束时间(Unix timestamp),单位:毫秒。

task_id

String

报告ID。

summary_info

表5 object

日报内容摘要信息

instance_info

表9 object

实例信息列表。

performance_stat

表10 object

性能统计分析列表。

disk_stat

表11 object

磁盘统计分析列表。

table_space_stat

表14 object

表空间统计分析列表。

slow_log_stat

表17 object

慢SQL统计分析列表。

full_sql_stat

表18 object

全量SQL统计分析列表。

inspection_stat

表20 object

巡检评分统计分析列表。

error_message

String

错误信息。

表5 HealthReportSummaryInfo

参数

参数类型

描述

analysis_results

Array of 表6 objects

分析结果列表。

表6 HealthReportAnalysisResult

参数

参数类型

描述

risk_code

String

风险点编码。

risk_level

String

风险点级别。

risk_content

String

风险点内容。

reasons

Array of 表7 objects

可能原因列表。

表7 HealthReportRiskReason

参数

参数类型

描述

reason_code

String

可能原因编码。

reason_content

String

可能原因内容。

suggestions

Array of 表8 objects

建议优化措施列表。

表8 HealthReportRiskSuggestion

参数

参数类型

描述

suggestion_code

String

建议优化措施编码。

suggestion_content

String

建议优化措施。

表9 HealthReportInstanceInfo

参数

参数类型

描述

tenant_id

String

账号ID。

project_id

String

项目ID。

instance_id

String

实例ID。

master_node_id

String

主节点ID。

instance_name

String

实例名称。

cpu

Integer

实例cpu核数。

mem

Integer

实例内存大小。

disk_size

Integer

磁盘大小。

disk_type

String

磁盘类型。

engine

String

实例引擎类型。

engine_version

String

引擎内核版本。

表10 HealthReportPerformanceStat

参数

参数类型

描述

peak_stats

Array of 表12 objects

峰值统计信息列表。

ratio_stats

Array of 表13 objects

比率值数据列表。

表11 HealthReportDiskStat

参数

参数类型

描述

peak_stats

Array of 表12 objects

峰值统计信息列表。

ratio_stats

Array of 表13 objects

比率值数据列表。

表12 HealthReportSingleValueStat

参数

参数类型

描述

metric

String

指标名。

value

Double

数值。

max_value

Double

最大值。

normalized

Double

归一化值。

stage

String

当前状态。

timestamp

Long

指标采集时间。

表13 HealthReportRatioStat

参数

参数类型

描述

metric

String

指标名。

max_value

Double

最大值。

critical_ratio

Double

高水位占比。

medium_ratio

Double

中水位占比。

light_ratio

Double

低水位占比。

表14 HealthReportTableSpaceStat

参数

参数类型

描述

size_top

Array of 表15 objects

表大小Top列表。

rows_top

Array of 表15 objects

表行数量Top列表。

size_incr_top

Array of 表16 objects

表大小增长Top列表。

rows_incr_top

Array of 表16 objects

表行数量增长Top列表。

analyze_success

Boolean

统计分析是否成功。

error_message

String

错误信息。

表15 HealthReportTableSpaceInfo

参数

参数类型

描述

database

String

数据库名。

table

String

表名。

db_engine

String

数据库引擎。

table_size

Long

表大小。

data_size

Long

数据大小。

index_size

Long

索引大小。

rows

Long

行数量。

表16 HealthReportTableSpaceIncrInfo

参数

参数类型

描述

database

String

数据库名。

table

String

表名。

increment

Long

增长量。

analyze_success

Boolean

统计分析是否成功。

error_message

String

错误信息。

表17 HealthReportSlowLogStat

参数

参数类型

描述

collect_slow_log

Boolean

是否收集慢SQL。

top_execute_slow_logs

Array of 表19 objects

慢SQL Top执行次数列表。

top_avg_query_time_slow_logs

Array of 表19 objects

慢SQL Top平均执行时间列表。

top_max_query_time_slow_logs

Array of 表19 objects

慢SQL Top最大执行时间列表。

rows_examined_exceeding

Array of 表19 objects

慢SQL Top扫描返回比列表。

analyze_success

Boolean

统计分析是否成功。

error_message

String

错误信息。

表18 HealthReportFullSqlStat

参数

参数类型

描述

collect_full_sql

Boolean

是否收集全量SQL。

execute_top_templates

Array of 表19 objects

全量SQL Top总执行次数列表。

sum_rows_examined_top_templates

Array of 表19 objects

全量SQL Top总扫描行数列表。

avg_cost_top_templates

Array of 表19 objects

全量SQL Top平均执行耗时列表。

analyze_success

Boolean

统计分析是否成功。

error_message

String

错误信息。

表19 HealthReportSqlTemplate

参数

参数类型

描述

template_id

String

模版ID。

template

String

模版内容。

databases

Array of strings

数据库列表。

times

Long

执行次数。

avg_query_time

Double

平均执行时间。

max_query_time

Double

最大执行时间。

avg_rows_examined

Double

平均扫描行数。

max_rows_examined

Double

最大扫描行数。

sum_rows_examined

Double

总扫描行数。

avg_rows_sent

Double

平均返回行数。

max_rows_sent

Double

最大返回行数。

表20 HealthReportInspectionStat

参数

参数类型

描述

inspection_score

Array of 表21 objects

巡检评分。

analyze_success

Boolean

统计分析是否成功。

error_message

String

错误信息。

表21 HealthReportInspectionScore

参数

参数类型

描述

score

Double

得分。

critical

Integer

严重事件。

medium

Integer

警告事件。

light

Integer

优化事件。

cpu_usage

Double

CPU使用率。

mem_usage

Double

内存使用率。

space_usage

Double

空间使用率。

connection_rate

Double

连接使用率。

iops_usage

Double

IOPS使用率。

thread_running

Double

活跃会话。

slow_sql_total

Long

慢SQL数量。

lost_points_detail_list

Array of 表22 objects

扣分详情。

表22 HealthReportLostPointsDetail

参数

参数类型

描述

metric

String

扣分项。

lost_points

Double

所扣分数。

risk_level

String

事件等级。

状态码: 400

表23 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

状态码: 500

表24 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

请求示例

获取实例健康诊断报告内容。

GET https://das.cn-north-7.myhuaweicloud.com/v3/052041494800d57c2f02c00275b4c247/instances/bcfa975193f1402fa11a6d4fd6baf5fbin01/get-instance-health-report?task_id=bb252ed0-3d06-489a-a662-6609e054e91c

响应示例

状态码: 200

Success.

{ 
  "success" : true, 
  "summary_info" : { 
    "analysis_results" : [ { 
      "risk_code" : "SLOW_LOG_ISSUE", 
      "risk_level" : "WARNING", 
      "risk_content" : "慢SQL问题", 
      "reasons" : [ { 
        "reason_code" : "SLOW_LOG_EXIST", 
        "reason_content" : "存在慢SQL", 
        "suggestions" : [ { 
          "suggestion_code" : "ANALYZE_SLOW_LOG", 
          "suggestion_content" : "分析慢SQL查找问题根源" 
        } ] 
      } ] 
    } ] 
  }, 
  "instance_info" : { 
    "tenant_id" : "05204146e600d48f0f02c002850ec340", 
    "project_id" : "052041494800d57c2f02c00275b4c247", 
    "instance_id" : "bcfa975193f1402fa11a6d4fd6baf5fbin01", 
    "instance_name" : "rds-sql-勿删1", 
    "cpu" : 2, 
    "mem" : 8, 
    "disk_size" : 60, 
    "disk_type" : "CLOUDSSD", 
    "engine" : "mysql", 
    "engine_version" : "5.7" 
  }, 
  "performance_stat" : { 
    "analyze_success" : true, 
    "peak_stats" : [ { 
      "metric" : "qps", 
      "value" : 64.88, 
      "max_value" : 11178, 
      "normalized" : 0.005804258364644837, 
      "stage" : "LIGHT", 
      "timestamp" : 1728756000 
    } ], 
    "ratio_stats" : [ { 
      "criticalThreshold" : 11178, 
      "mediumThreshold" : 7824.599999999999, 
      "lightThreshold" : 3353.4, 
      "metric" : "qps", 
      "max_value" : 11178, 
      "critical_ratio" : 0, 
      "medium_ratio" : 0, 
      "light_ratio" : 1 
    } ] 
  }, 
  "disk_stat" : { 
    "analyze_success" : true, 
    "peak_stats" : [ { 
      "metric" : "iops", 
      "value" : 91.9, 
      "max_value" : 4500, 
      "normalized" : 0.020422222222222224, 
      "stage" : "LIGHT", 
      "timestamp" : 1728750600 
    } ], 
    "ratio_stats" : [ { 
      "criticalThreshold" : 4500, 
      "mediumThreshold" : 3150, 
      "lightThreshold" : 1350, 
      "metric" : "iops", 
      "max_value" : 4500, 
      "critical_ratio" : 0, 
      "medium_ratio" : 0, 
      "light_ratio" : 1 
    } ] 
  }, 
  "table_space_stat" : { 
    "analyze_success" : true 
  }, 
  "slow_log_stat" : { 
    "analyze_success" : true, 
    "collect_slow_log" : true, 
    "top_execute_slow_logs" : [ { 
      "template_id" : "5B20B6BF446F926F", 
      "template" : "INSERT INTO test123 VALUES (?);", 
      "databases" : [ "test_db" ], 
      "times" : 83, 
      "avg_query_time" : 0.9021538595657752, 
      "max_query_time" : 45.08398997783661, 
      "avg_rows_examined" : 0, 
      "sum_rows_examined" : 0, 
      "avg_rows_sent" : 0 
    } ], 
    "rows_examined_exceeding" : [ ] 
  }, 
  "full_sql_Stat" : { 
    "analyze_success" : true, 
    "collect_full_sql" : true, 
    "execute_top_templates" : [ { 
      "template_id" : "B38F825636B24B7", 
      "template" : "CREATE TABLE IF NOT EXISTS table_001 (id int)", 
      "databases" : [ "test_db" ], 
      "times" : 1, 
      "avg_query_time" : 5, 
      "avg_rows_examined" : 0, 
      "sum_rows_examined" : 0 
    } ] 
  }, 
  "inspection_Stat" : { 
    "analyze_success" : true, 
    "inspection_score" : [ { 
      "score" : 100, 
      "critical" : 0, 
      "medium" : 0, 
      "light" : 0, 
      "cpu_usage" : 3.93, 
      "mem_usage" : 22.91, 
      "space_usage" : 8.66, 
      "connection_rate" : 0.54, 
      "iops_usage" : 0.28, 
      "thread_running" : 4, 
      "slow_sql_total" : 0, 
      "lost_points_detail_list" : [ { 
        "metric" : "memUsage", 
        "lost_points" : 0, 
        "risk_level" : "NORMAL" 
      }, { 
        "metric" : "cpuUsage", 
        "lost_points" : 0, 
        "risk_level" : "NORMAL" 
      }, { 
        "metric" : "spaceUsage", 
        "lost_points" : 0, 
        "risk_level" : "NORMAL" 
      }, { 
        "metric" : "iopsUsage", 
        "lost_points" : 0, 
        "risk_level" : "NORMAL" 
      }, { 
        "metric" : "connectionRate", 
        "lost_points" : 0, 
        "risk_level" : "NORMAL" 
      }, { 
        "metric" : "threadRunning", 
        "lost_points" : 0, 
        "risk_level" : "NORMAL" 
      }, { 
        "metric" : "slowSqlTotal", 
        "lost_points" : 0, 
        "risk_level" : "NORMAL" 
      } ] 
    } ] 
  } 
}

状态码

状态码

描述

200

Success.

400

Client error.

500

Server error.

错误码

请参见错误码

相关文档