本文汇总数据库工作台 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 |```json|锁耗时的统计结果，以秒为单位。 |\ | | |{| |\ | | | "Average": 0,| |\ | | | "Max": 0,| |\ | | | "Min": 0,| |\ | | | "Total": 0| |\ | | |}| |\ | | |```| |\ | | | | | |PTAnalysisResult |String |```json|仿 PT 解析工具输出结果的文本字符串。 |\ | | |\n# Attribute pct total min max avg\n#*******| |\ | | |```| |\ | | | | | |QueryTimeRatio |Integer |77.78 |查询总耗时占比。 | |QueryTimeStats |QueryTimeStatsObject |```json|锁耗时的统计结果，以秒为单位。 |\ | | |{| |\ | | | "Average": 3.5001745,| |\ | | | "Max": 4.00016,| |\ | | | "Min": 3.000189,| |\ | | | "Total": 7.000349| |\ | | |}| |\ | | |```| |\ | | | | | |RowsExaminedRatio |Integer |0 |扫描总行数占比。 | |RowsExaminedStats |RowsExaminedStatsObject |```json|扫描行数的统计结果。 |\ | | |{| |\ | | |"Average": 0,| |\ | | |"Max": 0,| |\ | | |"Min": 0,| |\ | | |"Total": 0| |\ | | |}| |\ | | |```| |\ | | | | | |RowsSentRatio |Integer |66.67 |返回总行数占比。 | |RowsSentStats |RowsSentStatsObject |```json|返回行数的统计结果。 |\ | | |{| |\ | | | "Average": 1,| |\ | | | "Max": 1,| |\ | | | "Min": 1,| |\ | | | "Total": 2| |\ | | |}| |\ | | |```| |\ | | | | | |SQLTemplate |String |```json|SQL 模板。 |\ | | |select sleep(?)| |\ | | |```| |\ | | | | | |SQLTemplateID |String |eb4a2b85844fd80206871a75c065411778729031ded219d92281062e8473\*\*\*\*\*\*\* |慢 SQL 模版的哈希值。 | |SourceIP |String |172.23.\*\*\*.\*\*\* |IP 地址。 | |User |String |test_user |执行者名称。 | ## ApprovalNodes 审批节点信息。被以下接口引用： * ListApprovalNode |**名称** |**类型** |**示例值** |**描述** | |---|---|---|---| |ApprovalUsers |Object[] |```JSON|节点审批人信息，包括用户 ID 和用户名。|\ | | |{| |\ | | | "UserId": "",| |\ | | | "UserName": ""| |\ | | | }| |\ | | |```| |\ | | | | | |CreateUser |String[] |```JSON|节点创建人信息，包括用户 ID 和用户名。|\ | | |{| |\ | | | "UserId": "",| |\ | | | "UserName": ""| |\ | | | }| |\ | | |```| |\ | | | | | |Memo |String |审批节点的备注信息。 |DBA | |NodeId |String |审批节点 ID。 |0 | |NodeName |String |审批节点名称。 |DBA | |NodeType |String |审批节点类型。返回值如下。|System |\ | | || |\ | | |* System：系统节点。| |\ | | |* Customize：自定义节点。 | | ## Array of ResList Object 诊断历史数组。被以下接口引用： * SlowQueryAdviceTaskHistoryApi |**参数** |**类型** |**示例值** |**描述** | |---|---|---|---| |Db |String |tpch |数据库名称。 | |Date |String |20250427 |诊断日期。使用 UTC + 8 时区，例如：20250427。 | |Status |String |SUCCESS |诊断任务状态。包括：|\ | | | ||\ | | | |* `INIT`：诊断中。|\ | | | |* `SUCCESS`：诊断成功。|\ | | | |* `EXCEPTION`：诊断异常。 | |AdviceNum |Integer |0 |待优化的 SQL 数量。|\ | | | |:::tip|\ | | | |索引建议 SQL 数量与待改写 SQL 数量，去重后的总数量，即待优化的 SQL 数量。|\ | | | ||\ | | | |:::| |SummaryId |String |9853ae90\-4052\-4953\-b117\-b1f59035\*\*\*\* |每次诊断的唯一标识。 | |SlowQueryNum |Integer |0 |总诊断慢 SQL 数量。 | |AdviceIndexNum |Integer |0 |索引建议 SQL 数量。 | |NoAdviceSQLNum |Integer |142 |无建议 SQL 数量。 | |AdviceRewriteNum |Integer |0 |待改写 SQL 数量。 | ## Array of AdvicesByGroup Object 诊断建议数组。被以下接口引用： * ListSlowQueryAdviceApi |**名称** |**类型** |示例值 |**描述** | |---|---|---|---| |Advice |String |建议用户结合业务逻辑对 SQL 进行优化调整 |按建议聚合的诊断建议。|\ | | | ||\ | | | |* 如果请求参数中 `AdviceType` 取值为 `index_advice`，该字段为索引 SQL。|\ | | | |* 如果请求参数中 `AdviceType` 取值为 `rewrite_sql_advice`，该字段为 SQL 建议。 | |advices |Array of Object |[Array of advices Object](#array-of-advices-object) |按模块聚合的诊断建议。如果请求参数中聚合类型是 `Module`，返回参数是 `Advices`。 | ## Array of advices Object 诊断模块信息数组。被以下接口引用： * ListSlowQueryAdviceApi |**名称** |**类型** |示例值 |**描述** | |---|---|---|---| |DB |String |tpch |数据库名。 | |agg |Object |[agg Object](#agg-object) |聚合信息。 | |Risk |String |无 |风险。 | |User |Array of String |sqlbrain |用户名。 | |Advice |String |建议用户结合业务逻辑对 SQL 进行优化调整 |诊断建议。|\ | | | ||\ | | | |* 如果请求参数中 `AdviceType` 取值为 `index_advice`，该字段为索引 SQL。|\ | | | |* 如果请求参数中 `AdviceType` 取值为 `rewrite_sql_advice`，该字段为 SQL 建议。 | |Benefit |Double |0 |优化后预估总耗时收益。 | |SpeedUp |Double |1 |优化后预估性能提升倍数。 | |SQLModule |String |SELECT `nation`,`o_year`,SUM(`amount`) AS `sum_profit` FROM (SELECT `n_name` AS `nation`,EXTRACT(YEAR FROM `o_orderdate`) AS `o_year`,`l_extendedprice` *(?\-* `*l_discount*` *)\-* `*ps_supplycost*l_quantity` AS `amount` FROM ((((((`part`) JOIN `supplier`) JOIN `lineitem`) JOIN `partsupp`) JOIN `orders`) JOIN `nation`) WHERE `s_suppkey`=`l_suppkey` AND `ps_suppkey`=`l_suppkey` AND `ps_partkey`=`l_partkey` AND `p_partkey`=`l_partkey` AND `o_orderkey`=`l_orderkey` AND `s_nationkey`=`n_nationkey` AND `p_name` LIKE ?) AS `profit` GROUP BY `nation`,`o_year` ORDER BY `nation`,`o_year` DESC |SQL 模板。 | |SourceIPs |Array of String |100.65.\*\*.\*\* |客户端地址。 | |TableName |String |L |表名。 | |AdviceLevel |String |Low |优化推荐程度。 | |AdviceIndexSize |Double |0 |推荐索引大小预估。 | |QueryTimeAvgAfter |Double |33.352660417661085 |优化后查询时间预估。 | ## Agg Object |**名称** |**类型** |示例值 |**描述** | |---|---|---|---| |DB |String |tpch |数据库名。 | |PSM |String |\- |内场 PSM。 | |User |String |sqlbrain |用户名。 | |Table |String |lineitem,nation,orders,part,partsupp,supplier |表名。 | |SourceIP |String |100.65.\*\*.\*\* |客户端地址。 | |SqlMethod |String |SELECT |SQL 类型。 | |SQLTemplate |String |55c9cb442b6418e35b79ac8797ecde33b664768318f2ed997c13bfe8c5e\*\*\*\* |慢 SQL 模板。 | |ExecuteCount |Integer |419 |执行次数。 | |LockTimeRatio |Double |0.03 |锁总耗时占比。 | |LockTimeStats |Object |```json|锁耗时的统计结果，以秒为单位。 |\ | | |{| |\ | | |"Max": 0.000013,| |\ | | |"Min": 0.000002,| |\ | | |"Total": 0.0017869999999999997,| |\ | | |"Average": 0.000004264916467780429| |\ | | |}| |\ | | |```| |\ | | | | | |RowsSentRatio |Double |0.04 |返回总行数占比。 | |RowsSentStats |Object |```json|返回行数的统计结果。 |\ | | |{| |\ | | |"Max": 175,| |\ | | |"Min": 175,| |\ | | |"Total": 73325,| |\ | | |"Average": 175| |\ | | |}| |\ | | |```| |\ | | | | | |SQLTemplateID |String |55c9cb442b6418e35b79ac8797ecde33b664768318f2ed997c13bfe8c5e\*\*\*\* |慢 SQL 模板哈希值。 | |LastAppearTime |Integer |1750982260 |最后一次出现的时间。 | |QueryTimeRatio |Double |15.12 |查询总耗时占比。 | |QueryTimeStats |Object |```json|查询耗时的统计结果，以秒为单位。 |\ | | |{| |\ | | |"Max": 37.44366,| |\ | | |"Min": 30.146108,| |\ | | |"Total": 461.0285326293491,| |\ | | |"Average": 13974.764714999996| |\ | | |}| |\ | | |```| |\ | | | | | |SqlFingerprint |String |\-\- |SQL 指纹。 | |FirstAppearTime |Integer |1750809748 |第一次出现的时间。 | |PTAnalysisResult |String |# Attribute pct total min max avg # ============= === ======= ======= ======= ======= # Count 0 419 # Exec time 15 13974.76s 30.15s 37.44s 33.35s # Lock time 0 1.8ms 2.0us 13.0us 4.3us # Rows sent 0 73.33k 175 175 175.00 # Rows examined 2 412.05M 965.28k 1.00M 983.41k # String: # Databases tpch # # EXPLAIN / *!50100 PARTITIONS*/ SELECT `nation`,`o_year`,SUM(`amount`) AS `sum_profit` FROM (SELECT `n_name` AS `nation`,EXTRACT(YEAR FROM `o_orderdate`) AS `o_year`,`l_extendedprice` *(?\-* `*l_discount*` *)\-* `*ps_supplycost*l_quantity` AS `amount` FROM ((((((`part`) JOIN `supplier`) JOIN `lineitem`) JOIN `partsupp`) JOIN `orders`) JOIN `nation`) WHERE `s_suppkey`=`l_suppkey` AND `ps_suppkey`=`l_suppkey` AND `ps_partkey`=`l_partkey` AND `p_partkey`=`l_partkey` AND `o_orderkey`=`l_orderkey` AND `s_nationkey`=`n_nationkey` AND `p_name` LIKE ?) AS `profit` GROUP BY `nation`,`o_year` ORDER BY `nation`,`o_year` DESC\G |仿 PT 解析工具输出结果的文本字符串。 | |ExecuteCountRatio |Double |0.03 |执行总次数占比。 | |RowsExaminedRatio |Double |1.77 |扫描总行数占比。 | |RowsExaminedStats |Object |```json|扫描行数的统计结果。 |\ | | |{| |\ | | |"Max": 1003217,| |\ | | |"Min": 965281,| |\ | | |"Total": 412050589,| |\ | | |"Average": 983414.2935560859| |\ | | |}| |\ | | |```| |\ | | | | | ## Column 表的列信息。 |**名称** |**类型** |**示例值** |**描述** | |---|---|---|---| |Name |String |name |字段名称。 | |Type |String |varchar |字段类型。 | |Length |String |32 |字段长度。 | |AllowBeNull |Bool |false |字段是否允许为 NULL。 | |Comment |String |gender |字段注释。 | |IsPrimaryKey |Bool |false |字段是否为主键。 | |IsAutoIncrement |Bool |false |字段是否为自增。 | |DefaultValue |String |male |字段默认值。 | ## DatabaseInfo 数据库信息。被以下接口引用： * ListDatabases |**名称** |**类型** |**示例值** |**描述** | |---|---|---|---| |Name |String |mysql |数据库名称。 | |CharacterSetName |String |utf8 |数据库字符集名称。 | |CollationName |String |utf8_general_ci |数据库排序集规则。 | |IsSystemDB |Bool |false |数据库是否为系统库。 | |Description |String |员工信息表 |数据库描述信息。 | ## DbwUsers 管理员信息。被以下接口引用： * DescribeManagedUsers |**名称** |**类型** |**示例值** |**描述** | |---|---|---|---| |AccountType|String|CHILD |账号类型。 |\ | | | | | |GroupDetails |String[] |```JSON|用户组信息，包括用户组 ID 和用户组名称。 |\ | | |{| |\ | | | "GroupId": "1962656497431244800",| |\ | | | "GroupName": "1111"| |\ | | | }| |\ | | |```| |\ | | | | | ## DescribeAuditLogDetailRow 审计日志的详细信息。被以下接口引用： * DescribeAuditLogDetail |**参数** |**类型** |**示例值** |**描述** |**支持的数据库类型** | |---|---|---|---|---| |User |String |root |执行者名称。 |* MySQL|\ | | | | |* veDB MySQL|\ | | | | |* PostgreSQL|\ | | | | |* Redis | |DB |String |information_schema |数据库名称。 |* MySQL|\ | | | | |* veDB MySQL|\ | | | | |* PostgreSQL|\ | | | | |* Redis | |SourceIP |String |127.0.0.1 |IP 地址。 |* MySQL|\ | | | | |* veDB MySQL|\ | | | | |* PostgreSQL|\ | | | | |* Redis | |OriSql |String |Select \* from func; |原始 SQL 文本。|* MySQL|\ | | | |:::tip|* veDB MySQL|\ | | | |当需要执行多个 SQL 语句时，可使用英文分号（;）进行分割。|* PostgreSQL|\ | | | ||* Redis |\ | | | |:::| | |AffectRow |Integer |0 |影响行数。 |* MySQL|\ | | | | |* veDB MySQL|\ | | | | |* PostgreSQL|\ | | | | |* Redis | |ExecTime |Integer |0 |执行开始时间，单位：秒。 |* MySQL|\ | | | | |* veDB MySQL|\ | | | | |* PostgreSQL|\ | | | | |* Redis | |Duration |Integer |0 |执行持续时间，单位：微秒。 |* MySQL|\ | | | | |* veDB MySQL|\ | | | | |* PostgreSQL|\ | | | | |* Redis | |LogLevel |String |Normal |日志等级，取值如下：|* MySQL|\ | | | ||* veDB MySQL|\ | | | |* `Normal`：表示正常日志。|* PostgreSQL |\ | | | |* `Incident`：表示冲突日志| |\ | | | |* `Warning`：表示警告日志。 | | |LogType |String |查询操作 |日志类型。常见的日志类型取值如下：|* MySQL|\ | | | ||* veDB MySQL|\ | | | |* 修改库|* PostgreSQL |\ | | | |* 修改表| |\ | | | |* 修改用户| |\ | | | |* 启动事务| |\ | | | |* 提交事务| |\ | | | |* 创建新表| |\ | | | |* 创建视图| |\ | | | |* 新建用户| |\ | | | |* 创建库| |\ | | | |* 创建索引| |\ | | | |* 创建导入| |\ | | | |* 执行表达式| |\ | | | |* 删除库| |\ | | | |* 删除索引| |\ | | | |* 删除视图| |\ | | | |* 删除表| |\ | | | |* 删除用户| |\ | | | |* 全表删除| |\ | | | |* 删除数据| |\ | | | |* 查询执行计划| |\ | | | |* Flush 操作| |\ | | | |* 替换数据| |\ | | | |* 插入数据| |\ | | | |* 调用存储过程| |\ | | | |* 索引建议| |\ | | | |* 终止会话| |\ | | | |* Load 数据| |\ | | | |* 锁表| |\ | | | |* Plan| |\ | | | |* 准备预处理| |\ | | | |* 执行预处理| |\ | | | |* 解除预处理| |\ | | | |* PURGE 操作| |\ | | | |* 查询操作| |\ | | | |* 重命名表| |\ | | | |* 重命名用户| |\ | | | |* 删除用户权限| |\ | | | |* 回滚| |\ | | | |* 设置变量操作| |\ | | | |* 显示信息| |\ | | | |* 查询执行信息| |\ | | | |* 清空表| |\ | | | |* 解锁表| |\ | | | |* 更新操作| |\ | | | |* 全量更新| |\ | | | |* 选库 | | |Table |String |tablename |表名。 |* MySQL|\ | | | | |* veDB MySQL|\ | | | | |* PostgreSQL | |SqlMethod |String |SELECT |SQL 类型。取值如下：|* MySQL|\ | | | ||* veDB MySQL|\ | | | |* `SELECT`：查询。|* PostgreSQL |\ | | | |* `INSERT`：插入。| |\ | | | |* `UPDATE`：更新。| |\ | | | |* `DELETE`：删除。| |\ | | | |* `ALTER`：修改。| |\ | | | |* `CREATE`：创建。| |\ | | | |* `DROP`：删除。| |\ | | | |* `RENAME`：重命名。| |\ | | | |* `TRUNCATE`：清除。| |\ | | | |* `LOGIN`：登录。| |\ | | | |* `LOGOUT`：退出。 | | |NodeId |String |proxy\-redis\-cnlfxwjm8wl\*\*\*\*\*\*\-1 |节点 ID。 |* Redis | |ScanRows |Integer |0 |扫描行数。 |\- PostgreSQL | |WaitLockConsumingTime |Integer |0 |锁等待时间。 |\- PostgreSQL | ## 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 列表信息。 | |LogLevel |Array of ErrLogLevel |["Warning"] |错误日志级别。取值如下：|\ | | | ||\ | | | |* `Note`：表示正常日志。|\ | | | |* `Warning`：表示警告日志。|\ | | | |* `Error`：表示错误日志。 | |Keyword |string |test1 |关键词模糊查询。 | ## FlowConfigs 审批流程信息。被以下接口引用： * ListApprovalFlowConfig |**名称** |**类型** |**示例值** |**描述** | |---|---|---|---| |AssociatedInstanceNum|String |1|当前审批流程被实例引用的次数。|\ | | | | | |ConfigId |String |1811243361378508800 |审批流程 ID。 | |ConfigName |String |cx\-test\-only |审批流程名称。 | |CreateUser |String[] |```JSON|审批流程创建人信息，包括用户 ID 和用户名。|\ | | |{| |\ | | | "UserId": "2100067216",| |\ | | | "UserName": "RootAccount"| |\ | | | }| |\ | | |```| |\ | | | | | |Memo |String |管理员单点 |审批流程的备注信息。 | |Type |String |Customize |审批流程类型。返回值如下。|\ | | | ||\ | | | |* System：系统节点。|\ | | | |* Customize：自定义节点。 | ## Result SQL 命令执行结果的详细信息。被以下接口引用： * [DataExecCommands](../6956/152609) * [ExecuteSQL](https://www.volcengine.com/docs/6956/2068407) |**名称** |**类型** |**示例值** |**描述** | |---|---|---|---| |CommandStr |string |Select \* from func; |执行的语句内容。 | |State |String |Success |命令执行状态，取值如下：|\ | | | ||\ | | | |* `Success`：命令执行成功。|\ | | | |* `Failed`：命令执行失败。|\ | | | |* `Cancel`：取消命令执行。|\ | | | |* `Pending`：命令等待执行。|\ | | | |* `Executing`：命令执行中。 | |ReasonDetail |string |UnknownError |当命令执行失败时，返回的信息。 | |RunTime |int64 |1665741434000 |执行 SQL 语句的开始时间戳，单位为：毫秒（ms）。 | |ColumnNames |array of String | |执行查询脚本时，返回的结果集字段列表。 |\ | | |```JSON| |\ | | |[| |\ | | |"name",| |\ | | |"ret",| |\ | | |"dl",| |\ | | |"type"| |\ | | |]| |\ | | |```| |\ | | | | | |RowCount |long |1000 |列表的行的总数。 | |Rows |Array of Cell | |列表的行的信息。 |\ | | |```JSON| |\ | | |[| |\ | | |{| |\ | | |"Cells": [| |\ | | |"87",| |\ | | |"01",| |\ | | |"权限管理",| |\ | | |"/admin/auth",| |\ | | |"1"| |\ | | |]| |\ | | |}| |\ | | |]| |\ | | |```| |\ | | | | | ## SearchParam 需要查询的审计日志的参数信息。被以下接口引用： * DescribeAuditLogDetail |**参数** |**类型** |**是否必选** |**示例值** |**描述** |**支持的数据库类型** | |---|---|---|---|---|---| |DBs |Array of String |否 |[ "information_schema" ] |数据库列表信息。 |* MySQL|\ | | | | | |* VeDB MySQL|\ | | | | | |* PostgreSQL|\ | | | | | |* Redis | |Users |Array of String |否 |[ "rootgg" ] |数据库账号列表信息。 |* MySQL|\ | | | | | |* VeDB MySQL|\ | | | | | |* PostgreSQL|\ | | | | | |* Redis | |SourceIPs |Array of String |否 |[ "192.168.0.33" ] |IP 列表。 |* MySQL|\ | | | | | |* VeDB MySQL|\ | | | | | |* PostgreSQL|\ | | | | | |* Redis | |LogLevels |Array of String |否 |["Normal", "Incident", "Warning"] |日志等级，取值如下：|* MySQL|\ | | | | ||* VeDB MySQL|\ | | | | |* `Normal`：表示正常日志。|* PostgreSQL |\ | | | | |* `Incident`：表示冲突日志| |\ | | | | |* `Warning`：表示警告日志。 | | |LogType |Array of String |否 |["创建表", "查询操作"] |日志类型。常见的日志类型取值如下：|* MySQL|\ | | | | ||* VeDB MySQL|\ | | | | |* 修改库|* PostgreSQL |\ | | | | |* 修改表| |\ | | | | |* 修改用户| |\ | | | | |* 启动事务| |\ | | | | |* 提交事务| |\ | | | | |* 创建新表| |\ | | | | |* 创建视图| |\ | | | | |* 新建用户| |\ | | | | |* 创建库| |\ | | | | |* 创建索引| |\ | | | | |* 创建导入| |\ | | | | |* 执行表达式| |\ | | | | |* 删除库| |\ | | | | |* 删除索引| |\ | | | | |* 删除视图| |\ | | | | |* 删除表| |\ | | | | |* 删除用户| |\ | | | | |* 全表删除| |\ | | | | |* 删除数据| |\ | | | | |* 查询执行计划| |\ | | | | |* Flush 操作| |\ | | | | |* 替换数据| |\ | | | | |* 插入数据| |\ | | | | |* 调用存储过程| |\ | | | | |* 索引建议| |\ | | | | |* 终止会话| |\ | | | | |* Load 数据| |\ | | | | |* 锁表| |\ | | | | |* Plan| |\ | | | | |* 准备预处理| |\ | | | | |* 执行预处理| |\ | | | | |* 解除预处理| |\ | | | | |* PURGE 操作| |\ | | | | |* 查询操作| |\ | | | | |* 重命名表| |\ | | | | |* 重命名用户| |\ | | | | |* 删除用户权限| |\ | | | | |* 回滚| |\ | | | | |* 设置变量操作| |\ | | | | |* 显示信息| |\ | | | | |* 查询执行信息| |\ | | | | |* 清空表| |\ | | | | |* 解锁表| |\ | | | | |* 更新操作| |\ | | | | |* 全量更新| |\ | | | | |* 选库 | | |DuringUp |Integer |否 |100 |执行时间上限，单位：微秒。 |* MySQL|\ | | | | | |* VeDB MySQL|\ | | | | | |* PostgreSQL|\ | | | | | |* Redis | |DuringDown |Integer |否 |10 |执行时间下限，单位：微秒。 |* MySQL|\ | | | | | |* VeDB MySQL|\ | | | | | |* PostgreSQL|\ | | | | | |* Redis | |AffectRowUp |Integer |否 |100 |影响行数上限。 |* MySQL|\ | | | | | |* VeDB MySQL|\ | | | | | |* PostgreSQL | |AffectRowDown |Integer |否 |100 |影响行数下限。 |* MySQL|\ | | | | | |* VeDB MySQL|\ | | | | | |* PostgreSQL | |SqlMethods |Array of String |否 |["SELECT", "INSERT"] |SQL 操作，取值如下：|* MySQL|\ | | | | ||* VeDB MySQL|\ | | | | |* `SELECT`：查询。|* PostgreSQL |\ | | | | |* `INSERT`：插入。| |\ | | | | |* `UPDATE`：更新。| |\ | | | | |* `DELETE`：删除。| |\ | | | | |* `ALTER`：修改。| |\ | | | | |* `CREATE`：创建。| |\ | | | | |* `DROP`：删除。| |\ | | | | |* `RENAME`：重命名。| |\ | | | | |* `TRUNCATE`：清除。| |\ | | | | |* `LOGIN`：登录。| |\ | | | | |* `LOGOUT`：退出。 | | |Tables |Array of String |否 |["table1"] |表名，从候选项中获取 |* MySQL|\ | | | | | |* VeDB MySQL|\ | | | | | |* PostgreSQL | |SqlFingerprint |String |否 |asdf\-asdf\-asdf\-xxxxx |SQL 指纹。 |* MySQL|\ | | | | | |* VeDB MySQL|\ | | | | | |* PostgreSQL | |NodeId |String |否 |proxy\-redis\-xxxx |节点 ID。|* Redis |\ | | | | |:::tip| |\ | | | | |您可以调用 [DescribeDBInstanceShards](../6293/1148756) 接口查看节点 ID。| |\ | | | | || |\ | | | | |:::| | |CmdKey |String |否 |keyword |关键词。 |\- Redis | ## 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）。 | ## SecGroupSearchParam 安全规则集数组。被以下接口引用： * DescribeSecurityGroups |**名称** |**类型** |**示例值** |**描述** | |---|---|---|---| |InstanceType|String |MySQL|数据库类型，当前支持的数据库如下所示。|\ | | | ||\ | | | |* `MySQL`：云数据库 MySQL 版。|\ | | | |* `VeDBMySQL`：云数据库 veDB MySQL 版。|\ | | | |* `Postgres`：云数据库 PostgresSQL 版。|\ | | | |* `Mongo`：文档数据库 MongoDB 版。|\ | | | |* `MSSQL`：云数据库 SQL Server 版。|\ | | | |* `Redis`：缓存数据库 Redis 版。 | |Keyword |String |mysql default |规则集名称。 | |SecurityGroupId |String |1740264867044012032 |规则集 ID。 | ## SecurityGroups 安全规则集信息。被以下接口引用： * DescribeSecurityGroups |**名称** |**类型** |**示例值** |**描述** | |---|---|---|---| |AssociatedInstanceNum |String |10 |关联实例的数量。 | |Category |String |Default |规则集类型，返回值如下。|\ | | | ||\ | | | |* Default：默认|\ | | | |* Custom：自定义 | |Comment |String |auto created by trigger 2100067216 |备注信息。 | |ID |String |1740264867044012032 |安全规则集 ID。 | |InstanceType |String |MySQL |数据库类型，当前支持的数据库如下所示。|\ | | | ||\ | | | |* MySQL：云数据库 MySQL 版|\ | | | |* VeDBMySQL：云数据库 veDB MySQL 版|\ | | | |* Postgres：云数据库 PostgresSQL 版|\ | | | |* Mongo：文档数据库 MongoDB 版|\ | | | |* MSSQL：云数据库 SQL Server 版 | |Name |String |mysql default |安全规则集名称。 | |UpdateTime |String |1703746451 |最近修改时间。 | ## 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 |```Plain Text|SQL 文本即实际执行的查询语句。 |\ | | |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| |\ | | |```| |\ | | | | | |SourceIP |String |192.168.0.33 |IP 地址。 | |User |String |rootgg |执行者名称。 | ## SlowLogSearchParam |**参数** |**类型** |**是否必选** |**示例值** |**描述** | |---|---|---|---|---| |SQLTemplate |String |否 |```json|SQL 模版。 |\ | | | |select * from test where id =?| |\ | | | |```| |\ | | | | | | |DBs |Array of String |否 |[test1,test2] |数据库名称列表。 | |Users |Array of String |否 |[root1,root2] |用户名列表。 | |SourceIPs |Array of String |否 |[127.0.0.1,127.0.0.2] |IP 列表。 | |MinQueryTime |Float |否 |0.05 |最短执行耗时时间。 | |MaxQueryTime |Float |否 |1.05 |最大执行耗时时间。 | |SQLTemplateID |String |否 |a86e95364af941743630cf16d94d09788ee171af3397afafb89401cb6\*\*\*\*\*\* |SQL 模版 ID。 | ## SQLKillRules |**名称** |**类型** |**示例值** |**描述** | |---|---|---|---| |TaskId |String |2005543523536\*\*\*\*\*\* |持续 Kill 任务的 ID。 | |CreateTime |String |2025\-12\-29T07:36:51Z |持续 Kill 任务的创建时间。 | |State |String|DONE|持续 Kill 任务状态，取值如下：|\ | | | ||\ | | | |* `ACTIVE`：表示任务运行中。|\ | | | |* `STOPPED`：表示任务已终止。|\ | | | |* `DONE`：表示任务已完成。|\ | | | |* `STOP_FAILED`：表示任务终止失败。|\ | | | |* `DELETE_FAILED`：表示任务删除失败。 | |SqlType |String |select,update,insert,delete |持续 Kill 任务的 SQL 类型。取值包括 `select`、`update`、`delete`、`insert`。 | |NodeType |String |Primary,ReadOnly|持续 Kill 任务的节点类型。取值包括 `Primary`（主节点）、`ReadOnly`（只读节点）。 |\ | | | | | |MaxExecTime |Integer |1 |SQL 执行时长，表示超过该时长的 SQL 请求会被 Kill。单位为秒（s），取值范围为 1~9999。 | |EffectiveTime |Integer |60 |任务持续时长，表示当持续 Kill 任务达到持续时长后，任务将被自动关闭。单位为秒（s），取值范围为 1~99999999。 | |RemainingTime |Integer |0 |持续 Kill 任务的剩余时长，单位为秒（s）。 | |User |String |RootAccount |持续 Kill 任务的创建者。 | ## TableMeta 表元数据信息。被以下接口引用： * GetTableInfo |**名称** |**类型** |**示例值** |**描述** | |---|---|---|---| |Name |String |employee |表名称。 | |Engine |String |InnoDB |存储引擎。 | |CharacterSet |String |utf8mb4 |表字符集。 | |Collations |String |utf8mb4_general_ci |表校验规则。 | |Definition |String |CREATE TABLE employee (\n id bigint(11) NOT NULL AUTO_INCREMENT,\n name varchar(60) NOT NULL,\n age smallint(10) NOT NULL,\n city varchar(60) NOT NULL,\n department varchar(60) NOT NULL,\n PRIMARY KEY (id)\n) ENGINE=InnoDB AUTO_INCREMENT=16394 DEFAULT CHARSET=utf8mb4 |建表 DDL 语句。 | |Columns |Array of Column |[Columns](https://www.volcengine.com/docs/6956/152615#9Z6RquWW) |表字段元信息列表 |