You need to enable JavaScript to run this app.
文档中心
数据库工作台

数据库工作台

复制全文
下载 pdf
SQL 洞察与审计
DescribeSqlTemplatesContrast
复制全文
下载 pdf
DescribeSqlTemplatesContrast
调用 DescribeSqlTemplatesContrast 接口查询两个时间段内全量 SQL 模板的聚合指标对比。
请求类型
同步请求。
请求参数
名称
类型
是否必选
示例值
描述
InstanceId
String
mysql-fcfc2c******
实例 ID。
说明
您可以按需选择以下接口查询实例 ID:
InstanceType
String
MySQL
数据库类型,当前支持的数据库如下所示。
  • MySQL:云数据库 MySQL 版。
  • VeDBMySQL:云数据库 veDB MySQL 版。
  • Postgres:云数据库 PostgresSQL 版。
FirstStartTime
Integer
1719820800
第一个对比时间段的开始时间,使用秒级时间戳。
FirstEndTime
Integer
1719824400
第一个对比时间段的结束时间,使用秒级时间戳。
结束时间一定要晚于开始时间。
SecondStartTime
Integer
1719907200
第二个对比时间段的开始时间,使用秒级时间戳。
SecondEndTime
Integer
1719910800
第二个对比时间段的结束时间,使用秒级时间戳。
结束时间一定要晚于开始时间。
RegionId
String
cn-beijing
地域 ID。
DbName
String
order_db
数据库名过滤条件。
SortBy
String
DESC
排序方向。取值如下:
  • ASC:表示升序。
  • DESC:表示降序。
OrderBy
String
ExecTime
排序指标。取值如下:
  • TotalExecTime:SQL 执行总耗时。
  • ExecTime:平均 SQL 执行总耗时。
  • Count:执行次数。
  • TotalCpuTime:CPU 总耗时。
  • CpuTime:平均 CPU 耗时。
  • RowlockWaitTime:平均 InnoDB 锁等待耗时。
  • MdlWaitTime:平均 MDL 锁等待耗时。
  • LatchWaitTime:平均 Latch 等待耗时。
  • TrxCommitTime:平均事务提交耗时。
  • CclWaitTime:平均 SQL 限流等待耗时。
  • SocketSendTime:平均 Socket 发送数据耗时。
  • ThreadSchedTime:平均线程调度等待耗时。
  • ThreadWaitTime:平均线程等待耗时。
  • RowsAffected:平均影响行数。
  • RowsExamined:平均扫描行数。
  • RowsSent:平均返回行数。
  • BytesSent:平均发送字节数。
  • InnodbPageAccess:平均逻辑页读取次数。
  • InnodbIoReadBytes:平均 IO 读取字节数。
  • InnodbIoReads:平均 IO 读页面数量。
  • TmpDiskTables:平均磁盘临时表数量。
SqlMethods
Array of string
["SELECT","UPDATE"]
SQL 类型过滤条件。取值包括:SELECTINSERTUPDATEDELETEALTERCREATEDROPRENAMETRUNCATEOTHER
Tables
Array of string
["orders"]
表名过滤条件。
NodeId
String
node-a
节点 ID。
CollectSqlFingerprint
Boolean
true
是否仅查询收藏的 SQL 模板。取值如下:
  • true:表示仅查询收藏的 SQL 模板。
  • false:表示查询所有数据。
SqlCommands
Array of string
["SELECT"]
SQL 命令过滤条件。
ExaminedRowDown
Integer
1000
扫描行数下限。用于限制返回结果中涉及的最大扫描行数,防止因数据量过大导致查询超时。
CountDown
Integer
10
执行次数下限(或记录条数下限)。用于限制返回的 SQL 记录数量。
返回参数
名称
类型
示例值
描述
Details
Array of TemplatesContrast
[
{
"DbName": "test_a",
"FirstTemplatesDetail": {
"BinlogSyncTime": 0,
"BytesSent": 0,
"CclWaitTime": 0,
"Count": 2,
"CpuTime": 490,
"DBName": "test_zhudi",
"ExecTime": 794,
"GroupFollowerWaitTime": 0,
"InnodbIoReadBytes": 0,
"InnodbIoReads": 0,
"InnodbPageAccess": 16,
"InstanceID": "mysql-cf8d83a2ea63",
"IsCollectSqlFingerprint": false,
"LatchWaitTime": 0,
"MdlWaitTime": 0,
"RedoLogFlushTime": 0,
"RowlockWaitTime": 0,
"RowsAffected": 0,
"RowsExamined": 4,
"RowsSent": 0,
"SemiSyncWaitTime": 0,
"ServerPort": "",
"SocketSendTime": 0,
"SqlFingerprint": "01c4dbcc021b24e3beff902d78115f5e",
"SqlTable": "TABLES",
"SqlTemplate": "SELECT `TABLE_NAME` FROM `information_schema`.`TABLES` WHERE `TABLE_SCHEMA`=? AND `TABLE_TYPE` IN (?+) LIMIT ?+",
"SqlType": "SELECT",
"TablelockWaitTime": 0,
"TcCommitTime": 0,
"TcFlushTime": 0,
"TenantID": "2100067216",
"ThreadSchedTime": 3,
"ThreadWaitTime": 0,
"TmpDiskTables": 0,
"TotalCpuTime": 980,
"TotalExecTime": 1588,
"TrxCommitTime": 0,
"WaitLockTime": 0
},
"SecondTemplatesDetail": {
"BinlogSyncTime": 0,
"BytesSent": 0,
"CclWaitTime": 0,
"Count": 14,
"CpuTime": 0,
"DBName": "test_zhudi",
"ExecTime": 8,
"GroupFollowerWaitTime": 0,
"InnodbIoReadBytes": 0,
"InnodbIoReads": 0,
"InnodbPageAccess": 0,
"InstanceID": "mysql-cf8d83a2ea63",
"IsCollectSqlFingerprint": false,
"LatchWaitTime": 0,
"MdlWaitTime": 0,
"RedoLogFlushTime": 0,
"RowlockWaitTime": 0,
"RowsAffected": 0,
"RowsExamined": 0,
"RowsSent": 0,
"SemiSyncWaitTime": 0,
"ServerPort": "",
"SocketSendTime": 0,
"SqlFingerprint": "quit",
"SqlTable": "-",
"SqlTemplate": "",
"SqlType": "Quit",
"TablelockWaitTime": 0,
"TcCommitTime": 0,
"TcFlushTime": 0,
"TenantID": "2100067216",
"ThreadSchedTime": 5,
"ThreadWaitTime": 0,
"TmpDiskTables": 0,
"TotalCpuTime": 0,
"TotalExecTime": 113,
"TrxCommitTime": 0,
"WaitLockTime": 0
},
"SqlFingerprint": "quit",
"SqlType": "Quit",
"TbName": "-"
}
]
SQL 模板对比明细列表。
Total
Integer
1
对比明细总数。
请求示例
POST /?Action=DescribeSqlTemplatesContrast&Version=2018-01-01 HTTP/1.1
Content-Type: application/json
Host: dbw.cn-beijing.volcengineapi.com
Authorization: HMAC-SHA256 Credential=AKLTN2I0MmFiNzMxNWE5NDgzMzk4MmVjMTVkODlkZTZ****/20211202/cn-beijing/dbw/request,SignedHeaders=x-date, Signature=71d31fc7bcf990142851c9833c5656391486cda0ae2e0b8ada733b7c645****
{
"InstanceId": "mysql-cf8d83a2ea63",
"InstanceType": "MySQL",
"FirstStartTime": 1787562620,
"FirstEndTime": 1787566220,
"SecondStartTime": 1787562620,
"SecondEndTime": 1787566220,
"SortBy": "DESC",
"OrderBy": "ExecTime",
"DbName": "test_a",
"Tables": [
"-",
"example",
"SCHEMATA",
"TABLES",
"KEY_COLUMN_USAGE",
"REFERENTIAL_CONSTRAINTS",
"tables"
],
"NodeId": "mysql-cf8d83a2ea63-sb2e3-0",
"SqlCommands": [
"Connect",
"SET_OPTION",
"SELECT",
"SHOW_FIELDS",
"SHOW_KEYS",
"SHOW_CREATE",
"Quit",
"CREATE_TABLE"
],
"CollectSqlFingerprint": false,
"RegionId": "cn-beijing"
}
返回示例
{
"ResponseMetadata": {
"RequestId": "2026082418112882C3F79E243440D87214-15e625",
"Action": "DescribeSqlTemplatesContrast",
"Version": "2018-01-01",
"Service": "dbw",
"Region": "cn-beijing"
},
"Result": {
"Details": [
{
"DbName": "test_a",
"FirstTemplatesDetail": {
"BinlogSyncTime": 0,
"BytesSent": 0,
"CclWaitTime": 0,
"Count": 2,
"CpuTime": 490,
"DBName": "test_zhudi",
"ExecTime": 794,
"GroupFollowerWaitTime": 0,
"InnodbIoReadBytes": 0,
"InnodbIoReads": 0,
"InnodbPageAccess": 16,
"InstanceID": "mysql-cf8d83a2ea63",
"IsCollectSqlFingerprint": false,
"LatchWaitTime": 0,
"MdlWaitTime": 0,
"RedoLogFlushTime": 0,
"RowlockWaitTime": 0,
"RowsAffected": 0,
"RowsExamined": 4,
"RowsSent": 0,
"SemiSyncWaitTime": 0,
"ServerPort": "",
"SocketSendTime": 0,
"SqlFingerprint": "01c4dbcc021b24e3beff902d78115f5e",
"SqlTable": "TABLES",
"SqlTemplate": "SELECT `TABLE_NAME` FROM `information_schema`.`TABLES` WHERE `TABLE_SCHEMA`=? AND `TABLE_TYPE` IN (?+) LIMIT ?+",
"SqlType": "SELECT",
"TablelockWaitTime": 0,
"TcCommitTime": 0,
"TcFlushTime": 0,
"TenantID": "2100067216",
"ThreadSchedTime": 3,
"ThreadWaitTime": 0,
"TmpDiskTables": 0,
"TotalCpuTime": 980,
"TotalExecTime": 1588,
"TrxCommitTime": 0,
"WaitLockTime": 0
},
"SecondTemplatesDetail": {
"BinlogSyncTime": 0,
"BytesSent": 0,
"CclWaitTime": 0,
"Count": 14,
"CpuTime": 0,
"DBName": "test_zhudi",
"ExecTime": 8,
"GroupFollowerWaitTime": 0,
"InnodbIoReadBytes": 0,
"InnodbIoReads": 0,
"InnodbPageAccess": 0,
"InstanceID": "mysql-cf8d83a2ea63",
"IsCollectSqlFingerprint": false,
"LatchWaitTime": 0,
"MdlWaitTime": 0,
"RedoLogFlushTime": 0,
"RowlockWaitTime": 0,
"RowsAffected": 0,
"RowsExamined": 0,
"RowsSent": 0,
"SemiSyncWaitTime": 0,
"ServerPort": "",
"SocketSendTime": 0,
"SqlFingerprint": "quit",
"SqlTable": "-",
"SqlTemplate": "",
"SqlType": "Quit",
"TablelockWaitTime": 0,
"TcCommitTime": 0,
"TcFlushTime": 0,
"TenantID": "2100067216",
"ThreadSchedTime": 5,
"ThreadWaitTime": 0,
"TmpDiskTables": 0,
"TotalCpuTime": 0,
"TotalExecTime": 113,
"TrxCommitTime": 0,
"WaitLockTime": 0
},
"SqlFingerprint": "quit",
"SqlType": "Quit",
"TbName": "-"
}
],
"Total": 1
}
}
错误码
更多详情,请参见错误码
最近更新时间:2026.09.01 14:02:02
这个页面对您有帮助吗?
有用
有用
无用
无用