数据结构

最近更新时间: 2026-08-26 00:20:14

MonitorMetric

监控数据

被如下接口引用:DescribeTopSpaceSchemaTimeSeries

名称 必选 允许NULL 类型 描述
Metric String 指标名称。
示例值: cpu_use_rate
Unit String 指标单位。
示例值: %
Values Array of Float 指标值。
示例值: [0.25,0.26]

EventInfo

异常事件信息。

被如下接口引用:DescribeHealthScore

名称 必选 允许NULL 类型 描述
EndTime Datetime_iso 结束时间。
示例值: 2019-01-01T12:00:00+08:00
Outline String 概要。
示例值: 复制IO线程中断
StartTime Datetime_iso 开始时间。
示例值: 2019-01-01T00:00:00+08:00
Severity Int64 严重程度。严重程度分为5级,按影响程度从高至低分别为:1:致命,2:严重,3:告警,4:提示,5:健康。
示例值: 1
ScoreLost Int64 扣分。
示例值: 5
Metric String 保留字段。
示例值: slave_io_running
Count Int64 告警数目。
示例值: 1
EventId Int64 事件 ID 。
示例值: 165387
DiagType String 诊断类型。
示例值: 复制

MonitorFloatMetric

监控数据(浮点型)

被如下接口引用:DescribeTopSpaceTableTimeSeries

名称 必选 允许NULL 类型 描述
Values Array of Float 指标值。
示例值: [0.2]
Metric String 指标名称。
示例值: cpu_use_rate
Unit String 指标单位。
示例值: %

ScoreDetail

扣分详情。

被如下接口引用:DescribeDBDiagReportTasks

名称 必选 允许NULL 类型 描述
IssueType String 扣分项分类,取值包括:可用性、可维护性、性能及可靠性。
示例值: 性能
ScoreLost Int64 扣分总分。
示例值: -20
ScoreLostMax Int64 扣分总分上限。
示例值: -30
Items Array of ScoreItem 扣分项列表。
示例值:查看

HealthStatus

实例健康详情。

被如下接口引用:DescribeDBDiagReportTasks

名称 必选 允许NULL 类型 描述
HealthLevel String 健康等级,取值包括:"HEALTH" - 健康;"SUB_HEALTH" - 亚健康;"RISK"- 危险;"HIGH_RISK" - 高危。
示例值: HEALTH
ScoreLost Int64 总扣分分数。
示例值: 0
ScoreDetails Array of ScoreDetail 扣分详情。
示例值:查看
HealthScore Int64 健康分数,满分100。
示例值: 100

SchemaSpaceData

库空间统计数据。

被如下接口引用:DescribeTopSpaceSchemas

名称 必选 允许NULL 类型 描述
FragRatio Float 碎片率(%)。
示例值: 0
TableRows Int64 行数。
示例值: 10
PhysicalFileSize Float 库中所有表对应的独立物理文件大小加和(MB)。
示例值: 0.2
TableSchema String 库名。
示例值: test_db
DataLength Float 数据空间(MB)。
示例值: 2.2
IndexLength Float 索引空间(MB)。
示例值: 1.0
DataFree Float 碎片空间(MB)。
示例值: 0
TotalLength Float 总使用空间(MB)。
示例值: 3.2

ScoreItem

诊断扣分项。

被如下接口引用:DescribeDBDiagReportTasks

名称 必选 允许NULL 类型 描述
TopSeverity String 健康等级,取值包括:信息、提示、告警、严重、致命。
示例值: 严重
Count Int64 该异常诊断项出现次数。
示例值: 2
ScoreLost Int64 扣分分数。
示例值: -30
DiagItem String 异常诊断项名称。
示例值: 慢SQL
IssueType String 诊断项分类,取值包括:可用性、可维护性、性能及可靠性。
示例值: 性能

HealthReportTask

健康报告任务详情。

被如下接口引用:DescribeDBDiagReportTasks

名称 必选 允许NULL 类型 描述
InstanceInfo InstanceBasicInfo 任务所属实例的基础信息。
示例值:查看
HealthStatus HealthStatus 健康报告中的健康信息。
示例值:查看
AsyncRequestId Int64 异步任务请求 ID。
示例值: 63452
Source String 任务的触发来源,支持的取值包括:"DAILY_INSPECTION" - 实例巡检;"SCHEDULED" - 定时生成;"MANUAL" - 手动触发。
示例值: DAILY_INSPECTION
Progress Int64 任务完成进度,单位%。
示例值: 100
CreateTime Datetime 任务创建时间。
示例值: 2019-09-10 12:13:14
StartTime Datetime 任务开始执行时间。
示例值: 2019-09-10 12:13:14
EndTime Datetime 任务完成执行时间。
示例值: 2019-09-10 12:13:14

DiagHistoryEventItem

实例诊断历史事件

被如下接口引用:DescribeDBDiagEvents、DescribeDBDiagHistory

名称 必选 允许NULL 类型 描述
Metric String 保留字段。
示例值: cpu_use_rate
EndTime Datetime 结束时间。
示例值: 2021-05-27 00:01:20
EventId Int64 事件唯一ID 。
示例值: 330858512
Outline String 诊断概要。
示例值: 存在未提交事务
DiagItem String 诊断项说明。
示例值: 事务未提交
InstanceId String 实例 ID 。
示例值: cdb-test1234
DiagType String 诊断类型。
示例值: 事务未提交
StartTime Datetime 开始时间。
示例值: 2021-05-27 00:01:10
Severity Int64 严重程度。严重程度分为5级,按影响程度从高至低分别为:1:致命,2:严重,3:告警,4:提示,5:健康。
示例值: 1
Region String 地域。
示例值: ap-xxxxxx

InstanceConfs

实例配置。

被如下接口引用:DescribeDiagDBInstances、ModifyDiagDBInstanceConf

名称 必选 允许NULL 类型 描述
DailyInspection String 数据库巡检开关, Yes/No。
示例值: Yes
OverviewDisplay String 实例概览开关,Yes/No。
示例值: Yes
AZType String AZType
示例值: 2
KeyDelimiters Array of String redis大key分析的自定义分割符,仅redis使用
示例值: [",",";",":","+","@","=","
ShardSize String ShardSize
示例值: 40960
ShardNum String 分片节点数量。
示例值: 3
AnalysisTopKey String 是否开启大key周期性分析,仅redis产品有效。
示例值: Yes
ReplicasNum String ReplicasNum
示例值: 2

StatDimension

会话统计的维度信息,可以多个维度

被如下接口引用:DescribeMySqlProcessList

名称 必选 允许NULL 类型 描述
Dimension String 维度名称,目前仅支持:SqlTag。
示例值: SqlTag
Data Array of String SQL 标签过滤与统计信息
示例:

示例 1:[p=position] 统计包含 p=position 标签的 SQL 会话。
示例 2:[p] 统计包含 p 标签的 SQL 会话。
示例 3:[p=position, c=idCard] 统计同时包含 p=position 标签和 c=idCard 标签的 SQL 会话。
示例值: p=postion1

Table

表结构。

被如下接口引用:DescribeNoPrimaryKeyTables

名称 必选 允许NULL 类型 描述
TableSchema String 库名。
示例值: demo_schema
TableName String 表名。
示例值: demo_table
Engine String 库表的存储引擎。
示例值: InnoDB
TableRows Int64 行数。
示例值: 2000
TotalLength Float 总使用空间(MB)。
示例值: 0.02

InstanceBasicInfo

实例基础信息。

被如下接口引用:DescribeDBDiagReportTasks

名称 必选 允许NULL 类型 描述
InstanceId String 实例ID。
示例值: cdb-c1nl9rpv
InstanceName String 实例名称。
示例值: dbbrain-test
Vip String 实例内网IP。
示例值: 127.0.0.1
Vport Int64 实例内网Port。
示例值: 3600
Product String 实例产品。
示例值: MySQL
EngineVersion String 实例引擎版本。
示例值: 5.6

MySqlProcess

关系型数据库线程

被如下接口引用:DescribeMySqlProcessList

名称 必选 允许NULL 类型 描述
User String 线程的操作账号名。
示例值: root
Host String 线程的操作主机地址。
示例值: 127.0.0.1:41528
DB String 线程的操作数据库。
示例值: demo_db
State String 线程的操作状态。
示例值: updating
Command String 线程的执行类型。
示例值: Execute
Time String 线程的操作时长,单位秒。
示例值: 1225
Info String 线程的操作语句。
示例值: DELETE FROM test WHERE time<=1
ID String 线程ID。
示例值: 12

StatisticDataInfo

统计分析维度下的统计数据详情

被如下接口引用:DescribeMySqlProcessList

名称 必选 允许NULL 类型 描述
Count Int64 数量。
示例值: 2
Name String 统计维度的值。
示例值: p=dbbrain,kk=cc
TimeAvg Float 平均时间。
示例值: 23.1
TimeSum Float 总时间。
示例值: 238.2

StatisticInfo

sql会话统计信息

被如下接口引用:DescribeMySqlProcessList

名称 必选 允许NULL 类型 描述
Dimension String 统计分析的维度。
示例值: SqlTag
Data Array of StatisticDataInfo 统计分析的维度下的统计数据详情。
示例值:查看

TableSpaceData

库表空间统计数据。

被如下接口引用:DescribeTopSpaceTables

名称 必选 允许NULL 类型 描述
PhysicalFileSize Float 表对应的独立物理文件大小(MB)。
示例值: 0.1
TableSchema String 库名。
示例值: demo_db
Engine String 库表的存储引擎。
示例值: InnoDB
IndexLength Float 索引空间(MB)。
示例值: 2.00
TotalLength Float 总使用空间(MB)。
示例值: 2.00
TableRows Int64 行数。
示例值: 9
TableName String 表名。
示例值: demo_table
DataLength Float 数据空间(MB)。
示例值: 2.00
DataFree Float 碎片空间(MB)。
示例值: 2.00
FragRatio Float 碎片率(%)。
示例值: 2.00

MonitorMetricSeriesData

单位时间间隔内的监控指标数据

被如下接口引用:DescribeTopSpaceSchemaTimeSeries

名称 必选 允许NULL 类型 描述
Series Array of MonitorMetric 监控指标。
示例值:查看
Timestamp Array of Int64 监控指标对应的时间戳。
示例值: [1622087750,1622087760]

MonitorFloatMetricSeriesData

单位时间间隔内的监控指标数据(浮点型)

被如下接口引用:DescribeTopSpaceTableTimeSeries

名称 必选 允许NULL 类型 描述
Timestamp Array of Int64 监控指标对应的时间戳。
示例值: [1621934398]
Series Array of MonitorFloatMetric 监控指标。
示例值:查看

HealthScoreInfo

获取健康得分返回的详情。

被如下接口引用:DescribeHealthScore

名称 必选 允许NULL 类型 描述
IssueTypes Array of IssueTypeInfo 异常详情。
示例值:查看
EventsTotalCount Int64 异常事件总数。
示例值: 3
HealthScore Int64 健康得分。
示例值: 100
HealthLevel String 健康等级, 如:"HEALTH", "SUB_HEALTH", "RISK", "HIGH_RISK"。
示例值: RISK

InstanceInfo

查询实例列表,返回实例的相关信息的对象。

被如下接口引用:DescribeDiagDBInstances

名称 必选 允许NULL 类型 描述
InstanceId String 实例ID。
示例值: cdb-test1234
HealthScore Int64 健康得分。
示例值: 100
TaskStatus Int64 任务状态。
示例值: 0
InstanceConf InstanceConfs 实例巡检/概览的状态。
示例值:查看
AuditRunningStatus String 实例审计日志运行状态:normal: 运行中; paused: 欠费暂停。
示例值: normal
InternalVport Int64 内网port。
示例值: 9090
Product String 所属产品。
示例值: MySql
InstanceType Int64 实例类型:1:MASTER;2:DR,3:RO,4:SDR。
示例值: 1
Source String 接入来源。
示例值: CLOUD_PLATFORM
Volume Int64 硬盘存储,单位GB。
示例值: 50
GroupId String 分组ID。
示例值: test-group
UniqSubnetId String 子网统一ID。
示例值: subnet-igztest
DeployMode String cdb类型。
示例值: CUSTOM
IsSupported Bool 是否是tcloud-dbbrain-address支持的实例。
示例值: true
InternalVip String 内网vip。
示例值: 10.5.0.9
Region String 实例所属地域。
示例值: ap-xxxxxx
SecAuditStatus String 实例安全审计日志开启状态:ON: 安全审计开启;OFF: 未开启安全审计。
示例值: OFF
InitFlag Int64 cdb实例初始化标志:0:未初始化;1:已初始化。
示例值: 1
ClusterId String 所属集群ID(仅对集群数据库产品该字段非空,如TDSQL-C)。
示例值: cynosdbmysql-92r4lpsa
AgentStatus String 自建MySQL的Agent状态,"not_deployed" - 未部署,"deploying" - 部署中,"connected" - 连接正常,"deploy_failed" - 连接失败,"monitoring" - 连接正常,"stopped" - 暂停连接,"connect_failed" - 连接失败,unknown - 未知。
示例值: monitoring
InstanceStatus String 自建MySQL的实例状态,"not_attached" - 未连接,"attached" - 连接正常,"failed" - 连接失败,"stopped" - 停止监控,unknown- 未知。
示例值: attached
EventCount Int64 异常事件数量。
示例值: 0
ClusterName String 所属集群名称(仅对集群数据库产品该字段非空,如TDSQL-C)。
示例值: 开发-测试库
InstanceName String 实例名称。
示例值: cdb-测试
Cpu Int64 核心数。
示例值: 1
Memory Int64 内存,单位MB。
示例值: 4000
EngineVersion String 数据库版本。
示例值: 5.6
UniqVpcId String 私有网络统一ID。
示例值: vpc-fstest
DeadlineTime Datetime 资源到期时间。
示例值: 2021-02-25 16:33:26
AuditPolicyStatus String 实例审计日志开启状态,ALL_AUDIT: 开启全审计;RULE_AUDIT: 开启规则审计;UNBOUND: 未开启审计。
示例值: UNBOUND
CreateTime String 创建时间。
示例值: 2021-02-25 16:33:26
Vip String 内网地址。
示例值: 127.0.0.1
Vport Int64 内网端口。
示例值: 3306
GroupName String 分组组名。
示例值: test-group-name
Status Int64 实例状态:0:发货中;1:运行正常;4:销毁中;5:隔离中。
示例值: 1

IssueTypeInfo

指标信息。

被如下接口引用:DescribeHealthScore

名称 必选 允许NULL 类型 描述
TotalCount Int64 异常事件总数。
示例值: 1
IssueType String 指标分类:AVAILABILITY:可用性,MAINTAINABILITY:可维护性,PERFORMANCE,性能,RELIABILITY可靠性。
示例值: AVAILABILITY
Events Array of EventInfo 异常事件。
示例值:查看

SchemaSpaceTimeSeries

库空间时序数据

被如下接口引用:DescribeTopSpaceSchemaTimeSeries

名称 必选 允许NULL 类型 描述
TableSchema String 库名
示例值: test_db
SeriesData MonitorMetricSeriesData 单位时间间隔内的空间指标数据。
示例值:查看

TableSpaceTimeSeries

库表空间时序数据

被如下接口引用:DescribeTopSpaceTableTimeSeries

名称 必选 允许NULL 类型 描述
TableName String 表名。
示例值: demo_table
TableSchema String 库名。
示例值: demo_db
Engine String 库表的存储引擎。
示例值: InnoDB
SeriesData MonitorFloatMetricSeriesData 单位时间间隔内的空间指标数据。
示例值:查看