数据结构

最近更新时间: 2026-10-10 00:13:34

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

StatisticDataInfo

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

被如下接口引用：DescribeMySqlProcessList

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

HealthScoreInfo

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

被如下接口引用：DescribeHealthScore

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

MonitorMetric

监控数据

被如下接口引用：DescribeTopSpaceSchemaTimeSeries

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

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

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

ScoreDetail

扣分详情。

被如下接口引用：DescribeDBDiagReportTasks

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

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

MonitorFloatMetric

监控数据（浮点型）

被如下接口引用：DescribeTopSpaceTableTimeSeries

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

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

IssueTypeInfo

指标信息。

被如下接口引用：DescribeHealthScore

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

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

StatisticInfo

sql会话统计信息

被如下接口引用：DescribeMySqlProcessList

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

MonitorFloatMetricSeriesData

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

被如下接口引用：DescribeTopSpaceTableTimeSeries

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

ScoreItem

诊断扣分项。

被如下接口引用：DescribeDBDiagReportTasks

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

TableSpaceTimeSeries

库表空间时序数据

被如下接口引用：DescribeTopSpaceTableTimeSeries

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

MonitorMetricSeriesData

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

被如下接口引用：DescribeTopSpaceSchemaTimeSeries

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

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 诊断类型。
示例值： 复制

SchemaSpaceTimeSeries

库空间时序数据

被如下接口引用：DescribeTopSpaceSchemaTimeSeries

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

Table

表结构。

被如下接口引用：DescribeNoPrimaryKeyTables

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

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

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

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