ContactItem
联系人contact描述。
被如下接口引用:DescribeAllUserContact。
名称 | 类型 | 描述 |
---|---|---|
Id | Integer | 联系人id。 |
Name | String | 联系人姓名。 |
String | 联系人绑定的邮箱。 |
DiagHistoryEventItem
实例诊断历史事件
被如下接口引用:DescribeDBDiagHistory。
名称 | 类型 | 描述 |
---|---|---|
DiagType | String | 诊断类型。 |
EndTime | Timestamp | 结束时间。 |
StartTime | Timestamp | 开始时间。 |
EventId | Integer | 事件 ID 。 |
Severity | Integer | 严重程度。严重程度分为5级,按影响程度从高至低分别为:1:致命,2:严重,3:告警,4:提示,5:健康。 |
Outline | String | 概要。 |
DiagItem | String | 诊断项。 |
InstanceId | String | 实例 ID 。 注意:此字段可能返回 null,表示取不到有效值。 |
Metric | String | 保留字段 注意:此字段可能返回 null,表示取不到有效值。 |
Region | String | 地域 注意:此字段可能返回 null,表示取不到有效值。 |
EventInfo
异常事件信息。
被如下接口引用:DescribeHealthScore。
名称 | 类型 | 描述 |
---|---|---|
EventId | Integer | 事件 ID 。 示例值:123456 |
DiagType | String | 诊断类型。 示例值:复制 |
StartTime | Timestamp ISO8601 | 开始时间。 示例值:2019-01-01T00:00:00+08:00 |
EndTime | Timestamp ISO8601 | 结束时间。 示例值:2019-01-01T12:00:00+08:00 |
Outline | String | 概要。 示例值:复制IO线程中断 |
Severity | Integer | 严重程度。严重程度分为5级,按影响程度从高至低分别为:1:致命,2:严重,3:告警,4:提示,5:健康。 示例值:1 |
ScoreLost | Integer | 扣分。 示例值:5 |
Metric | String | 保留字段。 示例值:slave_io_running |
Count | Integer | 告警数目。 示例值:1 |
GroupItem
描述组信息。
被如下接口引用:DescribeAllUserGroup。
名称 | 类型 | 描述 |
---|---|---|
Id | Integer | 组id。 |
Name | String | 组名称。 |
MemberCount | Integer | 组成员数量。 |
HealthReportTask
健康报告任务详情。
被如下接口引用:DescribeDBDiagReportTasks。
名称 | 类型 | 描述 |
---|---|---|
AsyncRequestId | Integer | 异步任务请求 ID。 示例值:63452 |
Source | String | 任务的触发来源,支持的取值包括:"DAILY_INSPECTION" - 实例巡检;"SCHEDULED" - 定时生成;"MANUAL" - 手动触发。 示例值:DAILY_INSPECTION |
Progress | Integer | 任务完成进度,单位%。 示例值:100 |
CreateTime | Timestamp | 任务创建时间。 示例值:2019-09-10 12:13:14 |
StartTime | Timestamp | 任务开始执行时间。 示例值:2019-09-10 12:13:14 |
EndTime | Timestamp | 任务完成执行时间。 示例值:2019-09-10 12:13:14 |
InstanceInfo | InstanceBasicInfo | 任务所属实例的基础信息。 示例值:- |
HealthStatus | HealthStatus | 健康报告中的健康信息。 示例值:- |
HealthScoreInfo
获取健康得分返回的详情。
被如下接口引用:DescribeHealthScore。
名称 | 类型 | 描述 |
---|---|---|
IssueTypes | Array of IssueTypeInfo | 异常详情。 示例值:- |
EventsTotalCount | Integer | 异常事件总数。 示例值:3 |
HealthScore | Integer | 健康得分。 示例值:100 |
HealthLevel | String | 健康等级, 如:"HEALTH", "SUB_HEALTH", "RISK", "HIGH_RISK"。 示例值:RISK |
HealthStatus
实例健康详情。
被如下接口引用:DescribeDBDiagReportTasks。
名称 | 类型 | 描述 |
---|---|---|
HealthScore | Integer | 健康分数,满分100。 示例值:100 |
HealthLevel | String | 健康等级,取值包括:"HEALTH" - 健康;"SUB_HEALTH" - 亚健康;"RISK"- 危险;"HIGH_RISK" - 高危。 示例值:HEALTH |
ScoreLost | Integer | 总扣分分数。 示例值:0 |
ScoreDetails | Array of ScoreDetail | 扣分详情。 注意:此字段可能返回 null,表示取不到有效值。 示例值:- |
InstanceBasicInfo
实例基础信息。
被如下接口引用:DescribeDBDiagReportTasks。
名称 | 类型 | 描述 |
---|---|---|
InstanceId | String | 实例ID。 示例值:cdb-c1nl9rpv |
InstanceName | String | 实例名称。 示例值:test |
Vip | String | 实例内网IP。 示例值:127.0.0.1 |
Vport | Integer | 实例内网Port。 示例值:3600 |
Product | String | 实例产品。 示例值:MySQL |
EngineVersion | String | 实例引擎版本。 示例值:5.6 |
InstanceConfs
实例配置。
被如下接口引用:DescribeDiagDBInstances, ModifyDiagDBInstanceConf。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
DailyInspection | String | 否 | 数据库巡检开关, Yes/No。 示例值:Yes |
OverviewDisplay | String | 否 | 实例概览开关,Yes/No。 示例值:Yes |
KeyDelimiters | Array of String | 否 | redis大key分析的自定义分割符,仅redis使用 注意:此字段可能返回 null,表示取不到有效值。 示例值:[",",":","@"] |
InstanceInfo
查询实例列表,返回实例的相关信息的对象。
被如下接口引用:DescribeDiagDBInstances。
名称 | 类型 | 描述 |
---|---|---|
InstanceId | String | 实例ID。 示例值:cdb-test |
InstanceName | String | 实例名称。 示例值:cdb-测试 |
Region | String | 实例所属地域。 示例值:ap-guangzhou |
HealthScore | Integer | 健康得分。 示例值:100 |
Product | String | 所属产品。 示例值:MySql |
EventCount | Integer | 异常事件数量。 示例值:0 |
InstanceType | Integer | 实例类型:1:MASTER;2:DR,3:RO,4:SDR。 示例值:1 |
Cpu | Integer | 核心数。 示例值:1 |
Memory | Integer | 内存,单位MB。 示例值:4000 |
Volume | Integer | 硬盘存储,单位GB。 示例值:50 |
EngineVersion | String | 数据库版本。 示例值:5.6 |
Vip | String | 内网地址。 示例值:127.0.0.1 |
Vport | Integer | 内网端口。 示例值:3306 |
Source | String | 接入来源。 示例值:TENCENT_CLOUD |
GroupId | String | 分组ID。 示例值:test-group |
GroupName | String | 分组组名。 示例值:test-group-name |
Status | Integer | 实例状态:0:发货中;1:运行正常;4:销毁中;5:隔离中。 示例值:1 |
UniqSubnetId | String | 子网统一ID。 示例值:subnet-igztest |
DeployMode | String | cdb类型。 示例值:CUSTOM |
InitFlag | Integer | cdb实例初始化标志:0:未初始化;1:已初始化。 示例值:1 |
TaskStatus | Integer | 任务状态。 示例值:0 |
UniqVpcId | String | 私有网络统一ID。 示例值:vpc-fstest |
InstanceConf | InstanceConfs | 实例巡检/概览的状态。 示例值:- |
DeadlineTime | Timestamp | 资源到期时间。 示例值:2021-02-25 16:33:26 |
IsSupported | Boolean | 是否是DBbrain支持的实例。 示例值:true |
SecAuditStatus | String | 实例安全审计日志开启状态:ON: 安全审计开启;OFF: 未开启安全审计。 示例值:OFF |
AuditPolicyStatus | String | 实例审计日志开启状态,ALL_AUDIT: 开启全审计;RULE_AUDIT: 开启规则审计;UNBOUND: 未开启审计。 示例值:UNBOUND |
AuditRunningStatus | String | 实例审计日志运行状态:normal: 运行中; paused: 欠费暂停。 示例值:normal |
InternalVip | String | 内网vip。 注意:此字段可能返回 null,表示取不到有效值。 |
InternalVport | Integer | 内网port。 注意:此字段可能返回 null,表示取不到有效值。 |
CreateTime | String | 创建时间。 |
ClusterId | String | 所属集群ID(仅对集群数据库产品该字段非空,如TDSQL-C)。 注意:此字段可能返回 null,表示取不到有效值。 |
ClusterName | String | 所属集群名称(仅对集群数据库产品该字段非空,如TDSQL-C)。 注意:此字段可能返回 null,表示取不到有效值。 |
IssueTypeInfo
指标信息。
被如下接口引用:DescribeHealthScore。
名称 | 类型 | 描述 |
---|---|---|
IssueType | String | 指标分类:AVAILABILITY:可用性,MAINTAINABILITY:可维护性,PERFORMANCE,性能,RELIABILITY可靠性。 示例值:AVAILABILITY |
Events | Array of EventInfo | 异常事件。 示例值:- |
TotalCount | Integer | 异常事件总数。 示例值:1 |
MailConfiguration
邮件发送配置
被如下接口引用:CreateMailProfile, CreateSchedulerMailProfile。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
SendMail | Integer | 是 | 是否开启邮件发送: 0, 否; 1, 是。 示例值:1 |
Region | Array of String | 是 | 地域配置, 如["ap-guangzhou", "ap-shanghai"]。巡检的邮件发送模板,配置需要发送巡检邮件的地域;订阅的邮件发送模板,配置当前订阅实例的所属地域。 示例值:["ap-guangzhou"] |
HealthStatus | Array of String | 是 | 发送指定的健康等级的报告, 如["HEALTH", "SUB_HEALTH", "RISK", "HIGH_RISK"]。 示例值:["HEALTH"] |
ContactPerson | Array of Integer | 否 | 联系人id, 联系人/联系组不能都为空。 示例值:[1,2] |
ContactGroup | Array of Integer | 否 | 联系组id, 联系人/联系组不能都为空。 示例值:[1,2] |
MonitorFloatMetric
监控数据(浮点型)
被如下接口引用:DescribeTopSpaceTableTimeSeries。
名称 | 类型 | 描述 |
---|---|---|
Metric | String | 指标名称。 |
Unit | String | 指标单位。 |
Values | Array of Float | 指标值。 注意:此字段可能返回 null,表示取不到有效值。 |
MonitorFloatMetricSeriesData
单位时间间隔内的监控指标数据(浮点型)
被如下接口引用:DescribeTopSpaceTableTimeSeries。
名称 | 类型 | 描述 |
---|---|---|
Series | Array of MonitorFloatMetric | 监控指标。 |
Timestamp | Array of Integer | 监控指标对应的时间戳。 |
MonitorMetric
监控数据
被如下接口引用:DescribeSlowLogTimeSeriesStats, DescribeTopSpaceSchemaTimeSeries。
名称 | 类型 | 描述 |
---|---|---|
Metric | String | 指标名称。 |
Unit | String | 指标单位。 |
Values | Array of Integer | 指标值。 注意:此字段可能返回 null,表示取不到有效值。 |
MonitorMetricSeriesData
单位时间间隔内的监控指标数据
被如下接口引用:DescribeSlowLogTimeSeriesStats, DescribeTopSpaceSchemaTimeSeries。
名称 | 类型 | 描述 |
---|---|---|
Series | Array of MonitorMetric | 监控指标。 |
Timestamp | Array of Integer | 监控指标对应的时间戳。 |
ProfileInfo
用户配置的信息
被如下接口引用:CreateMailProfile, CreateSchedulerMailProfile, DescribeMailProfile。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Language | String | 是 | 语言, 如"zh"。 |
MailConfiguration | MailConfiguration | 是 | 邮件模板的内容。 |
SchemaItem
SchemaItem数组
被如下接口引用:DescribeSlowLogTopSqls。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Schema | String | 是 | 数据库名称 |
SchemaSpaceData
库空间统计数据。
被如下接口引用:DescribeTopSpaceSchemas。
名称 | 类型 | 描述 |
---|---|---|
TableSchema | String | 库名。 示例值:test |
DataLength | Float | 数据空间(MB)。 示例值:2.2 |
IndexLength | Float | 索引空间(MB)。 示例值:1.0 |
DataFree | Float | 碎片空间(MB)。 示例值:0 |
TotalLength | Float | 总使用空间(MB)。 示例值:3.2 |
FragRatio | Float | 碎片率(%)。 示例值:0 |
TableRows | Integer | 行数。 示例值:10 |
PhysicalFileSize | Float | 库中所有表对应的独立物理文件大小加和(MB)。 注意:此字段可能返回 null,表示取不到有效值。 示例值:0.2 |
SchemaSpaceTimeSeries
库空间时序数据
被如下接口引用:DescribeTopSpaceSchemaTimeSeries。
名称 | 类型 | 描述 |
---|---|---|
TableSchema | String | 库名 示例值:test |
SeriesData | MonitorMetricSeriesData | 单位时间间隔内的空间指标数据。 |
ScoreDetail
扣分详情。
被如下接口引用:DescribeDBDiagReportTasks。
名称 | 类型 | 描述 |
---|---|---|
IssueType | String | 扣分项分类,取值包括:可用性、可维护性、性能及可靠性。 示例值:性能 |
ScoreLost | Integer | 扣分总分。 示例值:-20 |
ScoreLostMax | Integer | 扣分总分上限。 示例值:-30 |
Items | Array of ScoreItem | 扣分项列表。 注意:此字段可能返回 null,表示取不到有效值。 示例值:- |
ScoreItem
诊断扣分项。
被如下接口引用:DescribeDBDiagReportTasks。
名称 | 类型 | 描述 |
---|---|---|
DiagItem | String | 异常诊断项名称。 示例值:慢SQL |
IssueType | String | 诊断项分类,取值包括:可用性、可维护性、性能及可靠性。 示例值:性能 |
TopSeverity | String | 健康等级,取值包括:信息、提示、告警、严重、致命。 示例值:严重 |
Count | Integer | 该异常诊断项出现次数。 示例值:2 |
ScoreLost | Integer | 扣分分数。 示例值:-30 |
SecLogExportTaskInfo
安全审计日志导出任务信息
被如下接口引用:DescribeSecurityAuditLogExportTasks。
名称 | 类型 | 描述 |
---|---|---|
AsyncRequestId | Integer | 异步任务Id。 示例值:1 |
StartTime | Timestamp | 任务开始时间。 注意:此字段可能返回 null,表示取不到有效值。 示例值:2019-06-06 13:00:00 |
EndTime | Timestamp | 任务结束时间。 注意:此字段可能返回 null,表示取不到有效值。 示例值:2019-06-06 13:00:02 |
CreateTime | Timestamp | 任务创建时间。 示例值:2019-06-06 12:50:02 |
Status | String | 任务状态。 示例值:finished |
Progress | Integer | 任务执行进度。 示例值:100 |
LogStartTime | Timestamp | 导出日志开始时间。 注意:此字段可能返回 null,表示取不到有效值。 示例值:2019-06-06 12:00:00 |
LogEndTime | Timestamp | 导出日志结束时间。 注意:此字段可能返回 null,表示取不到有效值。 示例值:2019-06-06 13:00:00 |
TotalSize | Integer | 日志文件总大小,单位KB。 注意:此字段可能返回 null,表示取不到有效值。 示例值:100 |
DangerLevels | Array of Integer | 风险等级列表。0 无风险;1 低风险;2 中风险;3 高风险。 注意:此字段可能返回 null,表示取不到有效值。 示例值:[1,2,3] |
SlowLogHost
慢日志来源地址详情。
被如下接口引用:DescribeSlowLogUserHostStats。
名称 | 类型 | 描述 |
---|---|---|
UserHost | String | 来源地址。 示例值:127.0.0.1 |
Ratio | Float | 该来源地址的慢日志数目占总数目的比例,单位%。 示例值:50.0 |
Count | Integer | 该来源地址的慢日志数目。 示例值:30 |
SlowLogTopSqlItem
慢日志TopSql
被如下接口引用:DescribeSlowLogTopSqls。
名称 | 类型 | 描述 |
---|---|---|
LockTime | Float | sql总锁等待时间 示例值:0.00008 |
LockTimeMax | Float | 最大锁等待时间 示例值:0.000096 |
LockTimeMin | Float | 最小锁等待时间 示例值:0.000041 |
RowsExamined | Integer | 总扫描行数 示例值:584832 |
RowsExaminedMax | Integer | 最大扫描行数 示例值:101782 |
RowsExaminedMin | Integer | 最小扫描行数 示例值:584832 |
QueryTime | Float | 总耗时 示例值:0.513363 |
QueryTimeMax | Float | 最大执行时间 示例值:0.765213 |
QueryTimeMin | Float | 最小执行时间 示例值:0.629921 |
RowsSent | Integer | 总返回行数 示例值:292416 |
RowsSentMax | Integer | 最大返回行数 示例值:292416 |
RowsSentMin | Integer | 最小返回行数 示例值:292416 |
ExecTimes | Integer | 执行次数 示例值:37 |
SqlTemplate | String | sql模板 示例值:select * from t; |
SqlText | String | 带参数SQL(随机) 示例值:SELECT * FROM t; |
Schema | String | 数据库名 示例值:test_center |
QueryTimeRatio | Float | 总耗时占比 示例值:2.44 |
LockTimeRatio | Float | sql总锁等待时间占比 示例值:1.92 |
RowsExaminedRatio | Float | 总扫描行数占比 示例值:2.3 |
RowsSentRatio | Float | 总返回行数占比 示例值:18.67 |
QueryTimeAvg | Float | 平均执行时间 示例值:0.513363 |
RowsSentAvg | Float | 平均返回行数 示例值:26518.0 |
LockTimeAvg | Float | 平均锁等待时间 示例值:0.000096 |
RowsExaminedAvg | Float | 平均扫描行数 示例值:584832.0 |
Md5 | String | SQL模板的MD5值 示例值:AD7651E51E8C6FBA |
SlowLogUser
慢日志来源用户详情。
被如下接口引用:DescribeSlowLogUserHostStats。
名称 | 类型 | 描述 |
---|---|---|
UserName | String | 来源用户名。 示例值:root |
Ratio | Float | 该来源用户名的慢日志数目占总数目的比例,单位%。 示例值:50.0 |
Count | Integer | 该来源用户名的慢日志数目。 示例值:30 |
TableSpaceData
库表空间统计数据。
被如下接口引用:DescribeTopSpaceTables。
名称 | 类型 | 描述 |
---|---|---|
TableName | String | 表名。 |
TableSchema | String | 库名。 |
Engine | String | 库表的存储引擎。 |
DataLength | Float | 数据空间(MB)。 |
IndexLength | Float | 索引空间(MB)。 |
DataFree | Float | 碎片空间(MB)。 |
TotalLength | Float | 总使用空间(MB)。 |
FragRatio | Float | 碎片率(%)。 |
TableRows | Integer | 行数。 |
PhysicalFileSize | Float | 表对应的独立物理文件大小(MB)。 |
TableSpaceTimeSeries
库表空间时序数据
被如下接口引用:DescribeTopSpaceTableTimeSeries。
名称 | 类型 | 描述 |
---|---|---|
TableName | String | 表名。 |
TableSchema | String | 库名。 |
Engine | String | 库表的存储引擎。 |
SeriesData | MonitorFloatMetricSeriesData | 单位时间间隔内的空间指标数据。 |
TimeSlice
单位时间间隔内的慢日志统计
被如下接口引用:DescribeSlowLogTimeSeriesStats。
名称 | 类型 | 描述 |
---|---|---|
Count | Integer | 总数 |
Timestamp | Integer | 统计开始时间 |
UserProfile
用户配置的相关信息,包括邮件配置。
被如下接口引用:DescribeMailProfile。
名称 | 类型 | 描述 |
---|---|---|
ProfileId | String | 配置的id。 注意:此字段可能返回 null,表示取不到有效值。 示例值:123456 |
ProfileType | String | 配置类型。 注意:此字段可能返回 null,表示取不到有效值。 示例值:dbScan_mail_configuration |
ProfileLevel | String | 配置级别,"User"或"Instance"。 注意:此字段可能返回 null,表示取不到有效值。 示例值:User |
ProfileName | String | 配置名称。 注意:此字段可能返回 null,表示取不到有效值。 示例值:test |
ProfileInfo | ProfileInfo | 配置详情。 示例值:- |