文档中心

数据结构

最近更新时间：2024.02.23 10:01:37

首次发布时间：2022.11.18 17:51:54

本文汇总数据库工作台 DBW 的 API 接口中使用的数据结构定义详情。

AggregateSlowLogs

慢日志聚合信息数组。被以下接口引用：

DescribeAggregateSlowLogs

名称	类型	示例值	描述
DB	String	test	数据库名称。
ExecuteCount	Integer	2	执行次数。
ExecuteCountRatio	Integer	66.67	执行总次数占比。
FirstAppearTime	Integer	1702613263	第一次出现的时间，使用秒时间戳格式。
LastAppearTime	Integer	1702613273	最后一次出现的时间，使用秒时间戳格式。
LockTimeRatio	Integer	0	锁总耗时占比。
LockTimeStats	LockTimeStatsObject	`{ "Average": 0, "Max": 0, "Min": 0, "Total": 0 }`	锁耗时的统计结果，以秒为单位。
PTAnalysisResult	String	`\n# Attribute pct total min max avg\n# ============= === ======= ======= ======= =======\n# Count 67 2\n# Exec time 78 7.00s 3.00s 4.00s 3.50s\n# Lock time 0 0 0 0 0\n# Rows sent 67 2 1 1 1.00\n# Rows examined 0 0 0 0 0\n# String:\n# Databases zaizai\n# \n# EXPLAIN /!50100 PARTITIONS/\nselect sleep(?)\\G\n\n`	仿 PT 解析工具输出结果的文本字符串。
QueryTimeRatio	Integer	77.78	查询总耗时占比。
QueryTimeStats	QueryTimeStatsObject	`{ "Average": 3.5001745, "Max": 4.00016, "Min": 3.000189, "Total": 7.000349 }`	锁耗时的统计结果，以秒为单位。
RowsExaminedRatio	Integer	0	扫描总行数占比。
RowsExaminedStats	RowsExaminedStatsObject	`{ "Average": 0, "Max": 0, "Min": 0, "Total": 0 }`	扫描行数的统计结果。
RowsSentRatio	Integer	66.67	返回总行数占比。
RowsSentStats	RowsSentStatsObject	`{ "Average": 1, "Max": 1, "Min": 1, "Total": 2 }`	返回行数的统计结果。
SQLTemplate	String	`select sleep(?)`	SQL 模板。
SQLTemplateID	String	eb4a2b85844fd80206871a75c065411778729031ded219d92281062e8473*******	慢 SQL 模版的哈希值。
SourceIP	String	172.23.*.*	IP 地址。
User	String	test_user	执行者名称。

DescribeAuditLogDetailRow

审计日志的详细信息。被以下接口引用：

DescribeAuditLogDetail

参数	类型	示例值	描述
LogLevel	String	Normal	日志等级，取值如下： `Normal`：表示正常日志。 `Incident`：表示冲突日志 `Warning`：表示警告日志。
User	String	root	执行者名称。
DB	String	information_schema	数据库名称。
SourceIP	String	127.0.0.1	IP 地址。
LogType	String	查询操作	日志类型。常见的日志类型取值如下：修改库修改表修改用户启动事务提交事务创建新表创建视图新建用户创建库创建索引创建导入执行表达式删除库删除索引删除视图删除表删除用户全表删除删除数据查询执行计划 Flush 操作替换数据插入数据调用存储过程索引建议终止会话 Load 数据锁表 Plan 准备预处理执行预处理解除预处理 PURGE 操作查询操作重命名表重命名用户删除用户权限回滚设置变量操作显示信息查询执行信息清空表解锁表更新操作全量更新选库
Table	String	tablename	表名。
OriSql	String	Select * from func;	原始 SQL 文本。说明当需要执行多个 SQL 语句时，可使用英文分号（;）进行分割。
SqlMethod	String	SELECT	SQL 操作。取值如下： `SELECT`：查询。 `INSERT`：插入。 `UPDATE`：更新。 `DELETE`：删除。 `ALTER`：修改。 `CREATE`：创建。 `DROP`：删除。 `RENAME`：重命名。 `TRUNCATE`：清除。 `LOGIN`：登录。 `LOGOUT`：退出。
AffectRow	Integer	0	影响行数。
ExecTime	Integer	0	执行开始时间，单位：秒。
Duration	Integer	0	执行持续时间，单位：微秒。

ErrLog

错误日志列表信息。被以下接口引用：

DescribeErrLogs

名称	类型	示例值	描述
Timestamp	Integer	1705525166	日志收集时间，使用秒时间戳格式。
LogLevel	String	Note	错误日志级别。日志级别包括 `Note`、`Warning`、`Error`。
Content	String	Storing MySQL user name or password information in the master info repository is not secure and is therefore not recommended. Please consider using the USER and PASSWORD connection options for START SLAVE; see the 'START SLAVE Syntax' in the MySQL Manual for more information.	错误日志内容。
NodeId	String	mysql-898e213******-s58cb-0	所在节点 ID。

ErrLogSearchParam

错误日志的查询参数。被以下接口引用：

DescribeErrLogs

名称类型 示例值 描述

NodeIds Array of String ["mysql-898e21******-s58cb-0"] 节点 ID 列表信息。

名称	类型	示例值	描述
NodeIds	Array of String	["mysql-898e21******-s58cb-0"]	节点 ID 列表信息。
LogLevel	Array of ErrLogLevel	["Warning"]	错误日志级别。取值如下： `Note`：表示正常日志。 `Warning`：表示警告日志。 `Error`：表示错误日志。
Keyword	string	test1	关键词模糊查询。

LogLevel

Array of ErrLogLevel

["Warning"]

错误日志级别。取值如下：

Note：表示正常日志。
Warning：表示警告日志。
Error：表示错误日志。

Keyword string test1 关键词模糊查询。

Result

SQL 命令执行结果的详细信息。被以下接口引用：

DataExecCommands

名称	类型	示例值	描述
CommandStr	string	Select * from func;	执行的语句内容。
State	String	Success	命令执行状态，取值如下： Success：表示命令执行成功。 Failed：表示命令执行失败。 Cancel：表示取消执行命令。
ReasonDetail	string	UnknownError	当命令执行失败时，返回的信息。
RunTime	int64	1665741434000	执行 SQL 语句的开始时间戳，单位为：毫秒（ms）。
ColumnNames	array of String	[ "name", "ret", "dl", "type" ]	执行查询脚本时，返回的结果集字段列表。
RowCount	long	1000	列表的行的总数。
Rows	Array of Cell	[ { "Cells": [ "87", "01", "权限管理", "/admin/auth", "1" ] } ]	列表的行的信息。

SearchParam

需要查询的审计日志的参数信息。被以下接口引用：

DescribeAuditLogDetail

参数	类型	是否必选	示例值	描述
DBs	Array of String	否	[ "information_schema" ]	数据库列表信息。
Users	Array of String	否	[ "rootgg" ]	数据库账号列表信息。
SourceIPs	Array of String	否	[ "192.168.0.33" ]	IP 列表。
LogLevels	Array of String	否	["Normal", "Incident", "Warning"]	日志等级，取值如下： `Normal`：表示正常日志。 `Incident`：表示冲突日志 `Warning`：表示警告日志。
LogType	Array of String	否	["创建表", "查询操作"]	日志类型。常见的日志类型取值如下：修改库修改表修改用户启动事务提交事务创建新表创建视图新建用户创建库创建索引创建导入执行表达式删除库删除索引删除视图删除表删除用户全表删除删除数据查询执行计划 Flush 操作替换数据插入数据调用存储过程索引建议终止会话 Load 数据锁表 Plan 准备预处理执行预处理解除预处理 PURGE 操作查询操作重命名表重命名用户删除用户权限回滚设置变量操作显示信息查询执行信息清空表解锁表更新操作全量更新选库
DuringUp	Integer	否	100	执行时间上限，单位：微秒。
DuringDown	Integer	否	10	执行时间下限，单位：微秒。
AffectRowUp	Integer	否	100	影响行数上限。
AffectRowDown	Integer	否	100	影响行数下限。
SqlMethods	Array of String	否	["SELECT", "INSERT"]	SQL 操作，取值如下： `SELECT`：查询。 `INSERT`：插入。 `UPDATE`：更新。 `DELETE`：删除。 `ALTER`：修改。 `CREATE`：创建。 `DROP`：删除。 `RENAME`：重命名。 `TRUNCATE`：清除。 `LOGIN`：登录。 `LOGOUT`：退出。

SearchParamObject

慢日志执行搜索信息。被以下接口引用：

DescribeAggregateSlowLogs

名称	类型	是否必选	示例值	描述
GroupIgnored	Array of String	否	["SourceIP", "User"]	聚合参数。可选参数如下所示： `SourceIP`：IP 地址。 `User`：用户名称。
DBs	Array of string	否	["test1", "test2"]	数据库名称。可输入多个数据库名称，需使用英文逗号（,）隔开。
Users	Array of string	否	["root1", "root2"]	用户名称。可输入多个用户名称，需使用英文逗号（,）隔开。
Keywords	Array of string	否	["select", "insert"]	SQL 模版关键字。可输入多个关键字，需使用英文逗号（,）隔开。
MinQueryTime	Integer	否	20	慢 SQL 的最小耗时时间，单位为秒（s）。
MaxQueryTime	Integer	否	30	慢 SQL 的最大耗时时间，单位为秒（s）。

Slowlog

慢日志的详细信息。被以下接口引用：

DescribeSlowLogs

参数	类型	示例值	描述
ConnectionId	Integer	2145056	连接 ID。
DB	String	information_schema	数据库名称。
LockTime	Float	0	表示执行被查询对象时需要的锁等待时间，即查询对象可能在别的会话中被锁定，其他语言就需要等待锁释放才可以执行查询操作，这段时间就是锁等待时间。
QueryTime	Float	3.000151	表示查询语句的耗时。
Timestamp	Integer	1681097392	按照查询开始时间排序。
RowsExamined	Integer	1	表示查询时需要扫描的行数。
RowsSent	Integer	1	命中查询结果后返回数据的行数。
SQLTemplate	String	`select sleep(?);`	SQL 模板。
SQLText	String	`select sleep(3);\n/usr/sbin/mysqld, Version: 8.0.26 (MySQL Community Server (GPL)). started with:\nTcp port: 3306 Unix socket: /var/run/mysqld/mysqld.sock\nTime Id Command Argument`	SQL 文本即实际执行的查询语句。
SourceIP	String	192.168.0.33	IP 地址。
User	String	rootgg	执行者名称。