数据结构

最近更新时间:2024-09-03 01:38:23

我的收藏

Aggregation

mongodb慢查模板概览明细

被如下接口引用:DescribeIndexRecommendAggregationSlowLogs。

名称 类型 描述
AvgExecTime Integer 平均执行时间(ms)。
示例值:1233
AvgDocsExamined Integer 平均扫描行数。
示例值:348
SlowLogCount Integer 产生慢查次数(/天)。
示例值:1
SortCount Integer 内存排序次数。
示例值:0
SlowLogs Array of String 慢查模板概览。
注意:此字段可能返回 null,表示取不到有效值。
示例值:{"type":"command","ns":"welabel.ground_truth_data","appName":"MongoDB Compass","command":{"aggregate":"ground_truth_data","pipeline":[{"$match":{"is_skip":{"$ne":true}}},{"$project":{"labels":{"$filter":{"input":"$comments.data.error_labels","as":"com","cond":{"$eq":["$$com.questionType","single"]}}},"ground_truth_id":1}},{"$unwind":{"path":"$labels"}}

AlarmProfileList

通知模板

被如下接口引用:DescribeAlarmTemplate。

名称 类型 描述
IsWebHook Integer 0-不是 1-是
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
ReceiveUinCount Integer 接收告警用户数量
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
Lang String 语言
注意:此字段可能返回 null,表示取不到有效值。
示例值:cn
TemplateType String 模板类型
注意:此字段可能返回 null,表示取不到有效值。
示例值:msg_template
Remark String 备注
注意:此字段可能返回 null,表示取不到有效值。
ReceiveGroupCount Integer 接收组数量
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
UpdateUin Integer 更新用户的uin
注意:此字段可能返回 null,表示取不到有效值。
示例值:000001
ReceiveType Array of Integer 接收类型
注意:此字段可能返回 null,表示取不到有效值。
ReceiveInfo Array of ReceiveInfo 接收用户信息
注意:此字段可能返回 null,表示取不到有效值。
UpdateTime String 更新时间
注意:此字段可能返回 null,表示取不到有效值。
TemplateName String 模板名
注意:此字段可能返回 null,表示取不到有效值。
示例值:test
SendChannel Array of Integer 发送渠道
注意:此字段可能返回 null,表示取不到有效值。
示例值:[0, 1]
TemplateId Integer 模板id
注意:此字段可能返回 null,表示取不到有效值。
示例值:23455
WebHookCount Integer webhook数量
注意:此字段可能返回 null,表示取不到有效值。
示例值:0

AlarmsRules

告警规则

被如下接口引用:ModifyAlarmPolicy。

名称 类型 必选 描述
Interval Integer 间隔
示例值:0
Name String 告警名
示例值:磁盘空间利用率
Metric String 指标
示例值:SpaceUsage
Operator String 操作符
示例值:>
Severity String 等级
fatal-致命
critical-严重
warning-告警
information-通知

示例值:warning
Value Float 指标值
示例值:80

AuditInstance

实例详细信息

被如下接口引用:DescribeAuditInstanceList。

名称 类型 描述
AuditStatus String 审计状态,已开通审计为:YES,未开通审计为:ON。
示例值:NO
BillingAmount Integer 审计日志大小,为兼容老版本用。
示例值:12
BillingConfirmed Integer 计费确认状态,0-未确认;1-已确认。
示例值:0
ColdLogExpireDay Integer 低频存储时长。
示例值:23
ColdLogSize Integer 低频日志存储量单位MB。
示例值:0
HotLogExpireDay Integer 高频日志存储天数。
示例值:7
HotLogSize Integer 高频日志存储量,单位MB。
示例值:1222
InstanceId String 实例Id。
示例值:tdsql-kisjgx
LogExpireDay Integer 日志保存总天数,为高频存储时长+低频存储时长。
示例值:30
CreateTime String 实例创建时间。
示例值:2023-06-14 15:18:07
InstanceInfo AuditInstanceInfo 实例详细信息。

AuditInstanceFilter

实例列表查询条件

被如下接口引用:DescribeAuditInstanceList。

名称 类型 必选 描述
Name String 搜索条件名称
示例值:InstanceId
Values Array of String 要搜索的条件的值
示例值:tdsql-fk4kasq

AuditInstanceInfo

实例详情

被如下接口引用:DescribeAuditInstanceList。

名称 类型 描述
AppId Integer appId。
示例值:1235675344
AuditStatus Integer 审计状态,0-未开通审计;1-已开通审计。
示例值:1
InstanceId String 实例Id。
示例值:tdsql-ijlopwe
InstanceName String 实例名称。
示例值:test-env
ProjectId Integer 项目Id。
示例值:0
Region String 实例所在地域。
示例值:ap-guangzhou
ResourceTags Array of String 资源Tags。
注意:此字段可能返回 null,表示取不到有效值。
示例值:test

AuditLogFile

审计日志文件

被如下接口引用:DescribeAuditLogFiles。

名称 类型 描述
AsyncRequestId Integer 审计日志文件生成异步任务ID。
注意:此字段可能返回 null,表示取不到有效值。
示例值:123
FileName String 审计日志文件名称。
示例值:tdsql-8fyt6dkd_20230417-151100_to_20230417-151403_1681717077964.tar.gz
CreateTime String 审计日志文件创建时间。格式为 : "2019-03-20 17:09:13"。
注意:此字段可能返回 null,表示取不到有效值。
示例值:2019-03-20 17:09:13
Status String 文件状态值。可能返回的值为:
"creating" - 生成中;
"failed" - 创建失败;
"success" - 已生成;
注意:此字段可能返回 null,表示取不到有效值。
示例值:success
FileSize Float 文件大小,单位为 KB。
示例值:233
DownloadUrl String 审计日志下载地址。
ErrMsg String 错误信息。
Progress Float 文件生成进度。
示例值:20
FinishTime String 文件生成成功时间。
示例值:2019-03-20 17:09:13

AuditLogFilter

过滤条件。可按设置的过滤条件过滤日志。

被如下接口引用:CreateAuditLogFile。

名称 类型 必选 描述
Host Array of String 客户端地址。
示例值:127.0.0.1
DBName Array of String 数据库名称。
示例值:test
User Array of String 用户名。
示例值:root
SentRows Integer 返回行数。表示筛选返回行数大于该值的审计日志。
示例值:1
AffectRows Integer 影响行数。表示筛选影响行数大于该值的审计日志。
示例值:2
ExecTime Integer 执行时间。单位为:µs。表示筛选执行时间大于该值的审计日志。
示例值:3

ContactItem

联系人contact描述。

被如下接口引用:DescribeAllUserContact。

名称 类型 描述
Id Integer 联系人id。
示例值:1
Name String 联系人姓名。
示例值:test
Mail String 联系人绑定的邮箱。
示例值:test@qq.com

DiagHistoryEventItem

实例诊断历史事件

被如下接口引用:DescribeDBDiagEvents, DescribeDBDiagHistory。

名称 类型 描述
DiagType String 诊断类型。
EndTime Timestamp 结束时间。
StartTime Timestamp 开始时间。
EventId Integer 事件唯一ID 。
示例值:1
Severity Integer 严重程度。严重程度分为5级,按影响程度从高至低分别为:1:致命,2:严重,3:告警,4:提示,5:健康。
示例值:1
Outline String 诊断概要。
DiagItem String 诊断项说明。
InstanceId String 实例 ID 。
示例值:cdb-test
Metric String 保留字段。
注意:此字段可能返回 null,表示取不到有效值。
Region String 地域。

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。
示例值:1
Name String 组名称。
示例值:test
MemberCount Integer 组成员数量。
示例值:1

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,表示取不到有效值。
示例值:-

IndexesToBuild

推荐的索引

被如下接口引用:DescribeIndexRecommendInfo。

名称 类型 描述
Id Integer 索引id,唯一标识一个索引。
示例值:2344052
IndexCommand String 创建索引命令。
示例值:db.ground_truth_data.createIndex({ data.3d_point_set.labels: 1, label_result_url: 1 }, { background: true })
IndexStr String 索引字符串。
示例值:{ data.3d_point_set.labels: 1, label_result_url: 1 }
Level Integer 优化级别,1-4,优先级从高到低。
示例值:4
Score Integer 索引得分。
示例值:20
Signs Array of String 签名。
Status Integer 0-待创建;1-创建中。
示例值:0

IndexesToDrop

无效索引

被如下接口引用:DescribeIndexRecommendInfo。

名称 类型 描述
IndexStr String 索引字符串。
示例值:{ data.3d_point_set.labels: 1, label_result_url: 1 }
Score Integer 索引得分。
示例值:20
Reason String 无效原因。
示例值:重复创建
IndexCommand String 删除索引命令。
示例值:db.ground_truth_data.createIndex({ data.3d_point_set.labels: 1, label_result_url: 1 }, { background: true })
IndexName String 索引名。
示例值:test

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,表示取不到有效值。
ShardNum String 分片节点数量。
注意:此字段可能返回 null,表示取不到有效值。
示例值:3
AnalysisTopKey String 是否开启大key周期性分析,仅redis产品有效。
注意:此字段可能返回 null,表示取不到有效值。
示例值:Yes

InstanceID

实例id

被如下接口引用:ModifyAlarmPolicy。

名称 类型 必选 描述
InstanceId String 实例id
示例值:cdb-dxnfjfks

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,表示取不到有效值。
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

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]

MongoDBIndex

Mongodb索引项

被如下接口引用:DescribeIndexRecommendInfo。

名称 类型 描述
ClusterId String 实例id。
示例值:cmgo-2jrxxrlx
Collection String 表名。
示例值:ground_truth_data
Db String 库名。
示例值:test
Level Integer 优化级别,1-4,优先级从高到低。
示例值:4
Score Integer 得分。
示例值:800
IndexesToBuild Array of IndexesToBuild 推荐索引列表。
注意:此字段可能返回 null,表示取不到有效值。
IndexesToDrop Array of IndexesToDrop 无效索引列表。
注意:此字段可能返回 null,表示取不到有效值。

MonitorFloatMetric

监控数据(浮点型)

被如下接口引用:DescribeTopSpaceTableTimeSeries。

名称 类型 描述
Metric String 指标名称。
示例值:cpu_use_rate
Unit String 指标单位。
示例值:%
Values Array of Float 指标值。
注意:此字段可能返回 null,表示取不到有效值。
示例值:[0.2]

MonitorFloatMetricSeriesData

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

被如下接口引用:DescribeTopSpaceTableTimeSeries。

名称 类型 描述
Series Array of MonitorFloatMetric 监控指标。
Timestamp Array of Integer 监控指标对应的时间戳。
示例值:1621934398

MonitorMetric

监控数据

被如下接口引用:DescribeSlowLogTimeSeriesStats, DescribeTopSpaceSchemaTimeSeries。

名称 类型 描述
Metric String 指标名称。
示例值:cpu_use_rate
Unit String 指标单位。
示例值:%
Values Array of Float 指标值。
注意:此字段可能返回 null,表示取不到有效值。
示例值:0.25

MonitorMetricSeriesData

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

被如下接口引用:DescribeSlowLogTimeSeriesStats, DescribeTopSpaceSchemaTimeSeries。

名称 类型 描述
Series Array of MonitorMetric 监控指标。
Timestamp Array of Integer 监控指标对应的时间戳。
示例值:1622087758

MySqlProcess

关系型数据库线程

被如下接口引用:DescribeMySqlProcessList。

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

Process

实时会话详情。

被如下接口引用:DescribeRedisProcessList。

名称 类型 描述
Id Integer 会话 ID。
示例值:-12630381964471452
Address String 访问来源,IP 地址和端口号。
示例值:100.1.232.215:3006
FileDescriptor Integer 文件描述符。
示例值:15
Name String 会话名称,使用 CLIENT SETNAME 命令设置。
示例值:dbbrain
LastCommand String 最后一次执行的命令。
示例值:setnx
Age Integer 会话存活时间,单位:秒。
示例值:175498
Idle Integer 最后一次执行命令后空闲的时间,单位:秒。
示例值:2
ProxyId String 会话所属的 Proxy节点 ID。
示例值:66eb6c7d56608685c13c2f63cb7373bd95f27ae6

ProcessStatistic

实时会话统计详情。

被如下接口引用:DescribeProxyProcessStatistics。

名称 类型 描述
Items Array of SessionItem 会话详情数组。
AllConnSum Integer 总连接数。
示例值:1
ActiveConnSum Integer 总活跃连接数。
示例值:1

ProfileInfo

用户配置的信息

被如下接口引用:CreateMailProfile, CreateSchedulerMailProfile, DescribeMailProfile。

名称 类型 必选 描述
Language String 语言, 如"zh"。
示例值:zh
MailConfiguration MailConfiguration 邮件模板的内容。

ReceiveInfo

接收组信息

被如下接口引用:DescribeAlarmTemplate。

名称 类型 描述
ReceiveGroup Array of Integer 接收组
注意:此字段可能返回 null,表示取不到有效值。
EndReceiveTime String 最后接收时间
注意:此字段可能返回 null,表示取不到有效值。
ReceiveName String 接收名
注意:此字段可能返回 null,表示取不到有效值。
示例值:通知
SendChannel Array of Integer 推送渠道
注意:此字段可能返回 null,表示取不到有效值。
StartReceiveTime String 开始时间
注意:此字段可能返回 null,表示取不到有效值。
ReceiveUin Array of ReceiveUin 接收用户列表
注意:此字段可能返回 null,表示取不到有效值。

ReceiveUin

接收用户

被如下接口引用:DescribeAlarmTemplate。

名称 类型 描述
UinName String 用户名
注意:此字段可能返回 null,表示取不到有效值。
示例值:test
Uin String 用户id
注意:此字段可能返回 null,表示取不到有效值。
示例值:100001

RedisBigKeyTask

Redis大Key分析任务详情。

被如下接口引用:DescribeRedisBigKeyAnalysisTasks。

名称 类型 描述
AsyncRequestId Integer 异步任务请求 ID。
示例值:12306
CreateTime String 任务创建时间。
示例值:2024-01-02 21:02:24
StartTime String 任务开始时间。
示例值:2024-01-02 21:02:25
EndTime String 任务结束时间。
示例值:2024-01-08 11:52:41
TaskStatus String 任务状态。
示例值:finished
Progress Integer 任务执行进度。
示例值:100
ShardIds Array of Integer 任务包含的分片节点序号列表。
示例值:[2,3]

RedisKeySpaceData

redis key空间信息。

被如下接口引用:DescribeRedisTopBigKeys。

名称 类型 描述
Key String key名。
示例值:test
Type String key类型。
示例值:string
Encoding String key编码方式。
示例值:string
ExpireTime Integer key过期时间戳(毫秒),0代表未设置过期时间。
示例值:0
Length Integer key内存大小,单位Byte。
示例值:72
ItemCount Integer 元素个数。
示例值:1
MaxElementSize Integer 最大元素长度。
示例值:10
AveElementSize Integer 平均元素长度。
示例值:10
ShardId String 所属分片序号。
示例值:1

RedisPreKeySpaceData

redis key前缀空间信息

被如下接口引用:DescribeRedisTopKeyPrefixList。

名称 类型 描述
AveElementSize Integer 平均元素长度。
示例值:10
Length Integer 总占用内存(Byte)。
示例值:590
KeyPreIndex String key前缀。
示例值:dbb47cd0
ItemCount Integer 元素数量。
示例值:14
Count Integer key个数。
示例值:2
MaxElementSize Integer 最大元素长度。
示例值:36

SQLFilter

实例SQL限流任务。

被如下接口引用:DescribeSqlFilters。

名称 类型 描述
Id Integer 任务ID。
示例值:1234
Status String 任务状态,取值包括RUNNING - 运行中, FINISHED - 已完成, TERMINATED - 已终止。
示例值:FINISHED
SqlType String SQL类型,取值包括SELECT, UPDATE, DELETE, INSERT, REPLACE。
示例值:SELECT
OriginKeys String 筛选SQL的关键词,多个关键词用英文逗号拼接。
示例值:t1
OriginRule String 筛选SQL的规则。
示例值:SELECT, t1
RejectedSqlCount Integer 已拒绝SQL数目。
示例值:100
CurrentConcurrency Integer 当前并发数。
示例值:0
MaxConcurrency Integer 最大并发数。
示例值:1
CreateTime Timestamp ISO8601 任务创建时间。
示例值:2022-04-14 14:00:00
CurrentTime Timestamp ISO8601 当前时间。
示例值:2022-04-14 15:00:00
ExpireTime Timestamp ISO8601 限流过期时间。
示例值:2022-04-14 14:30:00

SchemaItem

SchemaItem数组

被如下接口引用:DescribeSlowLogTopSqls。

名称 类型 必选 描述
Schema String 数据库名称
示例值:test

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]

SessionItem

实时会话访问来源详情。

被如下接口引用:DescribeProxyProcessStatistics。

名称 类型 描述
Ip String 访问来源。
示例值:"127.0.0.1"
ActiveConn String 当前访问来源活跃连接数
示例值:"1"
AllConn Integer 当前访问来源总连接数
示例值:1

SlowLogHost

慢日志来源地址详情。

被如下接口引用:DescribeSlowLogUserHostStats。

名称 类型 描述
UserHost String 来源地址。
示例值:127.0.0.1
Ratio Float 该来源地址的慢日志数目占总数目的比例,单位%。
示例值:50.0
Count Integer 该来源地址的慢日志数目。
示例值:30

SlowLogInfoItem

慢日志详细信息

被如下接口引用:DescribeSlowLogs。

名称 类型 描述
Timestamp String 慢日志开始时间
示例值:2023-03-31 10:47:35
SqlText String sql语句
示例值:select * from t
Database String 数据库
示例值:information_schema
UserName String User来源
注意:此字段可能返回 null,表示取不到有效值。
示例值:root
UserHost String IP来源
注意:此字段可能返回 null,表示取不到有效值。
示例值:127.0.0.1
QueryTime Float 执行时间,单位秒
示例值:12.1
LockTime Float 锁时间,单位秒
注意:此字段可能返回 null,表示取不到有效值。
示例值:0.22
RowsExamined Integer 扫描行数
注意:此字段可能返回 null,表示取不到有效值。
示例值:12
RowsSent Integer 返回行数
注意:此字段可能返回 null,表示取不到有效值。
示例值:122

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

StatDimension

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

被如下接口引用:DescribeMySqlProcessList。

名称 类型 必选 描述
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

StatisticDataInfo

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

被如下接口引用:DescribeMySqlProcessList。

名称 类型 描述
Name String 统计维度的值。
注意:此字段可能返回 null,表示取不到有效值。
示例值:p=dbbrain,kk=cc
TimeAvg Float 平均时间。
注意:此字段可能返回 null,表示取不到有效值。
示例值:23.1
TimeSum Float 总时间。
注意:此字段可能返回 null,表示取不到有效值。
示例值:238.2
Count Integer 数量。
注意:此字段可能返回 null,表示取不到有效值。
示例值:2

StatisticInfo

sql会话统计信息

被如下接口引用:DescribeMySqlProcessList。

名称 类型 描述
Dimension String 统计分析的维度。
注意:此字段可能返回 null,表示取不到有效值。
示例值:SqlTag
Data Array of StatisticDataInfo 统计分析的维度下的统计数据详情。
注意:此字段可能返回 null,表示取不到有效值。

Table

表结构。

被如下接口引用:DescribeNoPrimaryKeyTables。

名称 类型 描述
TableSchema String 库名。
示例值:test
TableName String 表名。
示例值:test
Engine String 库表的存储引擎。
示例值:InnoDB
TableRows Integer 行数。
示例值:2000
TotalLength Float 总使用空间(MB)。
示例值:0.02

TableSpaceData

库表空间统计数据。

被如下接口引用:DescribeTopSpaceTables。

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

TableSpaceTimeSeries

库表空间时序数据

被如下接口引用:DescribeTopSpaceTableTimeSeries。

名称 类型 描述
TableName String 表名。
示例值:test
TableSchema String 库名。
示例值:test
Engine String 库表的存储引擎。
示例值:InnoDB
SeriesData MonitorFloatMetricSeriesData 单位时间间隔内的空间指标数据。

TaskInfo

展示 redis kill 会话任务状态。

被如下接口引用:DescribeProxySessionKillTasks。

名称 类型 描述
AsyncRequestId Integer 异步任务 ID。
示例值:1234
InstProxyList Array of String 当前实例所有 proxy 列表。
示例值:["6511ec503b047be913e30c1bbf1f2c8c861e8347"]
InstProxyCount Integer 当前实例所有 proxy 数量。
示例值:1
CreateTime Timestamp ISO8601 任务创建时间。
示例值:"2022-02-11 10:22:46"
StartTime Timestamp ISO8601 任务启动时间。
示例值:"2022-02-11 10:22:46"
TaskStatus String 任务的状态,支持的取值包括:"created" - 新建;"chosen" - 待执行; "running" - 执行中;"failed" - 失败;"finished" - 已完成。
示例值:"finished"
FinishedProxyList Array of String 完成 kill 任务的 proxyId。
示例值:["6511ec503b047be913e30c1bbf1f2c8c861e8347"]
FailedProxyList Array of String kill 任务实行失败的 proxyId。
示例值:["6511ec503b047be913e30c1bbf1f2c8c861e8347"]
EndTime Timestamp ISO8601 任务结束时间。
示例值:"2022-02-11 10:22:46"
Progress Integer 任务执行进度。
示例值:100
InstanceId String 实例 ID。
示例值:crs-test1

TemplateInfo

通知模板

被如下接口引用:ModifyAlarmPolicy。

名称 类型 必选 描述
TemplateId String 模板id
示例值:23002
TemplateName String 模板名
示例值:测试

TimeSlice

单位时间间隔内的慢日志统计

被如下接口引用:DescribeSlowLogTimeSeriesStats。

名称 类型 描述
Count Integer 总数
示例值:1
Timestamp Integer 统计开始时间
示例值:1622087673

UserProfile

用户配置的相关信息,包括邮件配置。

被如下接口引用:DescribeMailProfile。

名称 类型 描述
ProfileId String 配置的id。
注意:此字段可能返回 null,表示取不到有效值。
示例值:123456
ProfileType String 配置类型,支持值包括:"dbScan_mail_configuration" - 数据库巡检邮件配置,"scheduler_mail_configuration" - 定期生成邮件配置。
注意:此字段可能返回 null,表示取不到有效值。
示例值:dbScan_mail_configuration
ProfileLevel String 配置级别,支持值包括:"User" - 用户级别,"Instance" - 实例级别,其中数据库巡检邮件配置为用户级别,定期生成邮件配置为实例级别。
注意:此字段可能返回 null,表示取不到有效值。
示例值:User
ProfileName String 配置名称。
注意:此字段可能返回 null,表示取不到有效值。
示例值:test
ProfileInfo ProfileInfo 配置详情。
示例值:-