更新时间:2025-03-25 GMT+08:00
分享

导出全量SQL明细

功能介绍

全量SQL开关打开后,创建SQL洞察任务,支持按节点、用户名、数据库、操作类型等导出全量SQL明细数据。该功能仅支持付费实例。

调试

您可以在API Explorer中调试该接口。

URI

GET /v3/{project_id}/instances/{instance_id}/full-sql-search

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

租户在某一Region下的项目ID。

获取方法请参见获取项目ID

约束限制:

不涉及。

取值范围:

只能由英文字母、数字组成,且长度为32个字符。

默认取值:

不涉及。

instance_id

String

参数解释:

实例ID。标识实例的唯一标识。

约束限制:

不涉及。

取值范围:

只能由英文字母、数字组成,且长度为32个字符。

默认取值:

不涉及。

表2 Query参数

参数

是否必选

参数类型

描述

start_at

Long

参数解释:

开始时间(Unix timestamp),单位:毫秒。

约束限制:

不涉及。

取值范围:

[0, 2^31-1],实际取决于查询。

默认取值:

不涉及。

end_at

Long

参数解释:

结束时间(Unix timestamp),单位:毫秒。

约束限制:

不涉及。

取值范围:

[0, 2^31-1],实际取决于查询。

默认取值:

不涉及。

task_ids

Array of long

参数解释:

SQL洞察任务ID列表,时间范围大于1天的SQL洞察任务后台将拆分为多个任务解析,该场景支持多任务过滤导出。

约束限制:

可组合,用逗号分隔。

取值范围:

[0, 2^31-1],实际取决于查询。

默认取值:

不涉及。

node_id

String

参数解释:

节点ID。

约束限制:

不涉及。

取值范围:

只能由英文字母、数字组成,且长度为32个字符。

默认取值:

不涉及。

keyword

String

参数解释:

关键字。

约束限制:

可组合,用逗号分隔。

取值范围:

不涉及。

默认取值:

不涉及。

fuzzy

String

参数解释:

是否模糊匹配。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

user_list

String

参数解释:

用户名

约束限制:

可组合,用逗号分隔。

取值范围:

不涉及。

默认取值:

不涉及。

db_list

String

参数解释:

数据库

约束限制:

可组合,用逗号分隔。

取值范围:

不涉及。

默认取值:

不涉及。

operation_list

String

参数解释:

操作类型

约束限制:

可组合,用逗号分隔。

取值范围:

不涉及。

默认取值:

不涉及。

client_ip_list

String

参数解释:

客户端IP

约束限制:

可组合,用逗号分隔。

取值范围:

不涉及。

默认取值:

不涉及。

thread_id_list

String

参数解释:

线程ID

约束限制:

可组合,用逗号分隔。

取值范围:

不涉及。

默认取值:

不涉及。

trx_id_list

String

参数解释:

事务ID

约束限制:

可组合,用逗号分隔。

取值范围:

不涉及。

默认取值:

不涉及。

session_id_list

String

参数解释:

会话ID

约束限制:

可组合,用逗号分隔。

取值范围:

不涉及。

默认取值:

不涉及。

status_list

String

参数解释:

执行状态

约束限制:

可组合,用逗号分隔。

取值范围:

  • 0:成功
  • 1:失败

默认取值:

不涉及。

sql_template_ids

String

参数解释:

SQL模板ID

约束限制:

可组合,用逗号分隔。

取值范围:

不涉及。

默认取值:

不涉及。

cost_min

Double

参数解释:

最小执行耗时(毫秒)。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

cost_max

Double

参数解释:

最大执行耗时(毫秒)。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

scan_min

Long

参数解释:

最小扫描行数。

约束限制:

不涉及。

取值范围:

[0, 2^31-1],实际取决于查询。

默认取值:

不涉及。

scan_max

Long

参数解释:

最大扫描行数。

约束限制:

不涉及。

取值范围:

[0, 2^31-1],实际取决于查询。

默认取值:

不涉及。

affect_min

Long

参数解释:

最小影响行数。

约束限制:

不涉及。

取值范围:

[0, 2^31-1],实际取决于查询。

默认取值:

不涉及。

affect_max

Long

参数解释:

最大影响行数。

约束限制:

不涉及。

取值范围:

[0, 2^31-1],实际取决于查询。

默认取值:

不涉及。

return_min

Long

参数解释:

最小返回行数。

约束限制:

不涉及。

取值范围:

[0, 2^31-1],实际取决于查询。

默认取值:

不涉及。

return_max

Long

参数解释:

最大返回行数。

约束限制:

不涉及。

取值范围:

[0, 2^31-1],实际取决于查询。

默认取值:

不涉及。

sort_field

String

参数解释:

排序字段。

约束限制:

不涉及。

取值范围:

  • execute_at:执行时间
  • execute_cost:执行耗时
  • lock_wait_time:锁等待时间
  • rows_examined:扫描行数
  • rows_returned:返回行数

默认取值:

不涉及。

asc

Boolean

参数解释:

排序顺序。

约束限制:

不涉及。

取值范围:

  • true:正序
  • false:逆序

默认取值:

不涉及。

page

Integer

参数解释:

页码。

约束限制:

不涉及。

取值范围:

[0, 2^31-1],实际取决于查询。

默认取值:

不涉及。

limit

Integer

参数解释:

每页记录数。

约束限制:

不涉及。

取值范围:

[0, 100],实际取决于查询。

默认取值:

不涉及。

请求参数

无。

响应参数

状态码: 200

表3 响应Body参数

参数

参数类型

描述

full_sql_details

Array of 表4 objects

参数解释:

全量SQL明细列表。

取值范围:

不涉及。

total

Integer

参数解释:

总数。

取值范围:

不涉及。

表4 full_sql_details

参数

参数类型

描述

sql

String

参数解释:

SQL语句。

取值范围:

不涉及。

sql_template_id

String

参数解释:

SQL模板ID。

取值范围:

不涉及。

operate_type

String

参数解释:

操作类型。

取值范围:

不涉及。

status

String

参数解释:

状态。

取值范围:

不涉及。

error_no

String

参数解释:

错误码。

取值范围:

不涉及。

database

String

参数解释:

数据库。

取值范围:

不涉及。

thread_id

String

参数解释:

线程ID。

取值范围:

不涉及。

client

String

参数解释:

客户端。

取值范围:

不涉及。

user

String

参数解释:

用户。

取值范围:

不涉及。

execute_at

Long

参数解释:

执行开始时间(Unix timestamp),单位:毫秒。

取值范围:

不涉及。

query_time

Double

参数解释:

执行耗时(毫秒)。

取值范围:

不涉及。

lock_time

Double

参数解释:

锁等待耗时(毫秒)。

取值范围:

不涉及。

rows_examined

Long

参数解释:

扫描行数。

取值范围:

不涉及。

rows_sent

Long

参数解释:

返回行数。

取值范围:

不涉及。

rows_affected

Long

参数解释:

更新行数。

取值范围:

不涉及。

trx_id

Long

参数解释:

事务ID。

取值范围:

不涉及。

cpu_time

Double

参数解释:

CPU耗时(微秒)。

取值范围:

不涉及。

send_bytes

Long

参数解释:

网络发送字节数。

取值范围:

不涉及。

query_tables

String

参数解释:

查询中所有的表名(格式:库名.表名|库名.表名)。

取值范围:

不涉及。

innodb_io_read_bytes

Long

参数解释:

物理I/O读字节数。

取值范围:

不涉及。

innodb_io_read

Integer

参数解释:

物理I/O读次数。

取值范围:

不涉及。

innodb_io_read_wait

Double

参数解释:

物理I/O读取等待耗时(毫秒)。

取值范围:

不涉及。

innodb_lock_wait

Double

参数解释:

行锁等待耗时(毫秒)。

取值范围:

不涉及。

innodb_queue_wait

Double

参数解释:

进入innodb的等待耗时(毫秒)。

取值范围:

不涉及。

kernel_version

String

参数解释:

内核版本号,DDM实例使用。

取值范围:

不涉及。

query_time_detail

String

参数解释:

SQL执行各阶段细分耗时,DDM实例使用。

取值范围:

不涉及。

session_id

String

参数解释:

会话ID。

取值范围:

不涉及。

node_id

String

参数解释:

节点ID。

取值范围:

只能由英文字母、数字组成,且长度为32个字符。

请求示例

GET https://das.cn-north-1.myhuaweicloud.com/v3/054e292c9880d4992f02c0196d3ea468/instances/da304cd5bbb944de828759bc7be3d3fein01/full-sql-search?start_at=1738733117000&end_at=1738808281000&task_ids=1128

响应示例

状态码: 200

{
  "full_sql_details": [
    {
      "sql": "select sleep(90)",
      "sql_template_id": "AAD913807ECE9C66",
      "operate_type": "select",
      "status": "success",
      "error_no": "",
      "database": "test_db",
      "thread_id": "5866666",
      "client": "100.79.3.154",
      "user": "root",
      "execute_at": 1738808280958,
      "query_time": 90000,
      "lock_time": 0,
      "rows_examined": 0,
      "rows_sent": 1,
      "rows_affected": 0,
      "trx_id": 0,
      "cpu_time": 0,
      "node_id": "fec05693c76c4f389561051db430324cno01"
    }
  ],
  "total": 1036
}

状态码

状态码

描述

200

导出全量SQL明细。

400

客户端错误。

500

服务器错误。

错误码

请参见错误码

相关文档