# 查询单条SQL详情 - QueryingDetailsofaSingleSQLStatement #### 功能介绍 查询单条SQL详情。对于分布式版实例，可查询对应SQL的完整执行记录，包含CN和DN上SQL语句执行历史。 - 调用接口前，您需要了解API [认证鉴权](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_011.html)。 - 调用接口前，您需要提前获取到[地区和终端节点](https://developer.huaweicloud.com/endpoint)。 #### 调试 您可以在[API Explorer](https://apiexplorer.developer.huaweicloud.com/apiexplorer/doc?product=GaussDBforopenGauss&api=ShowFullSql)中调试该接口。 #### URI GET /v3/{project_id}/instances/{instance_id}/full-sqls/{sql_exec_id} 表1路径参数 | **参数** | **是否必选** | **参数类型** | **描述** | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释：** 租户在某一Region下的项目ID。 获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_196.html)。 **约束限制：** 不涉及。 **取值范围：** 只能由英文字母、数字组成，且长度为32个字符。 **默认取值**： 不涉及。 | | instance_id | 是 | String | **参数解释：** 实例ID，此参数是用户创建实例的唯一标识。请参考[查询数据库实例列表 - QueryingDBInstances](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_328.html)接口获取实例ID。 **约束限制：** 不涉及。 **取值范围：** 只能由英文字母、数字组成，且长度为36个字符。 **默认取值** **：** 不涉及。 | | sql_exec_id | 是 | String | **参数解释** **：** 唯一SQL ID，对应内核字段：debug_query_id。获取方式请参考[查询全量单条SQL列表 - QueryingFullDatabySQLStatement](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_541.html)。 **约束限制** **：** 不涉及。 **取值范围** **：** 不涉及。 **默认取值** **：** 不涉及。 | 表2请求Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | id | 否 | String | **参数解释：** 采集到的全量SQL记录的唯一键ID。获取方式请参考[查询全量单条SQL列表 - QueryingFullDatabySQLStatement](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_541.html)。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值** **：** 不涉及。 | | sql_id | 否 | String | **参数解释：** 归一化SQL ID，对应内核字段：unique_sql_id。获取方式请参考[查询全量单条SQL列表 - QueryingFullDatabySQLStatement](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_541.html)。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值** **：** 不涉及。 | #### 请求参数 表3请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释：** 用户Token。 通过调用IAM服务[获取用户Token](https://support.huaweicloud.com/api-iam/iam_30_0001.html)接口获取。 请求响应成功后在响应消息头中包含的"X-Subject-Token"的值即为Token值。 **约束限制：** 不涉及。 **取值范围** **：** 不涉及。 **默认取值** **：** 不涉及。 | | X-Language | 否 | String | **参数解释：** 指定接口返回信息的语言类型。 **约束限制：** 不涉及。 **取值范围** **：** - **zh-cn：**中文 - **en-us** **：**英文 **默认取值** **：** **en-us** | #### 响应参数 表4响应Body参数 | **参数** | **参数类型** | **描述** | |:---|:---|:---| | trace_statistics | Object | **参数解释** **：** 链路详情。只对查询参数中sql_id取值，且id为空时生效。 详情请参见[表5]。 | | components | Array | **参数解释** **：** 组件上SQL执行记录列表。 详情请参见[表6]。 | 表5FullSqlTraceStatistics | **参数** | **参数类型** | **描述** | |:---|:---|:---| | hit_rate | Double | **参数解释** **：** 命中率。 **取值范围** **：** 不涉及。 | | db_time | Long | **参数解释** **：** 有效DB时间花费（单位：微秒）。 **取值范围** **：** 不涉及。 | | cpu_time | Long | **参数解释** **：** CPU时间（单位：微秒）。 **取值范围** **：** 不涉及。 | | io_time | Long | **参数解释** **：** IO时间（单位：微秒）。 **取值范围** **：** 不涉及。 | | execution_time | Long | **参数解释** **：** 执行器内执行时间（单位：微秒）。 **取值范围** **：** 不涉及。 | | scan_rows | Long | **参数解释** **：** 扫描行数。 **取值范围** **：** 不涉及。 | | update_rows | Long | **参数解释** **：** 更新行数。 **取值范围** **：** 不涉及。 | | insert_rows | Long | **参数解释** **：** 插入行数。 **取值范围** **：** 不涉及。 | | delete_rows | Long | **参数解释** **：** 删除行数。 **取值范围** **：** 不涉及。 | 表6ComponentDetail | **参数** | **参数类型** | **描述** | |:---|:---|:---| | component_id | String | **参数解释** **：** 组件ID。 **取值范围** **：** 不涉及。 | | db_name | String | **参数解释** **：** 数据库名称。 **取值范围** **：** 不涉及。 | | schema_name | String | **参数解释** **：** schema名称。 **取值范围** **：** 不涉及。 | | origin_node | String | **参数解释** **：** 原始节点。 **取值范围** **：** 不涉及。 | | username | String | **参数解释** **：** 用户名。 **取值范围** **：** 不涉及。 | | application_name | String | **参数解释** **：** 用户发起的请求的应用程序名称。 **取值范围** **：** 不涉及。 | | client_addr | String | **参数解释** **：** 用户发起的请求的客户端地址。 **取值范围**： 不涉及。 | | client_port | String | **参数解释** **：** 用户发起请求的客户端端口。 **取值范围**： 不涉及。 | | parent_sql_id | String | **参数解释** **：** 当前语句的外层SQL的归一化SQL ID。 **取值范围** **：** 不涉及。 | | sql_id | String | **参数解释** **：** 归一化SQL ID，对应内核字段：unique_sql_id。 **取值范围** **：** 不涉及。 | | sql_exec_id | String | **参数解释** **：** 唯一SQL ID，对应内核字段：debug_query_id。 **取值范围** **：** 不涉及。 | | transaction_id | String | **参数解释** **：** 事务ID，对应内核字段：transaction_id。 **取值范围** **：** 不涉及。 | | trace_id | String | **参数解释** **：** 链路ID。 **取值范围** **：** 不涉及。 | | query | String | **参数解释** **：** 归一化SQL。 **取值范围** **：** 不涉及。 | | sql | String | **参数解释** **：** 解析后的原始SQL文本。 开启track_stmt_parameter参数后，会把SQL文本中的变量替换成真实值，展示原始的SQL。对于track_stmt_parameter参数关闭时采集的SQL文本，无法获取到SQL参数变量的值，展示的内容为空。 **取值范围** **：** 不涉及。 | | thread_id | String | **参数解释** **：** 线程ID。 **取值范围** **：** 不涉及。 | | session_id | String | **参数解释** **：** 会话ID。 **取值范围** **：** 不涉及。 | | start_time | String | **参数解释** **：** 开始时间，格式为"yyyy-mm-ddThh:mm:ss.SSSSSZ"。 **取值范围** **：** 不涉及。 | | finish_time | String | **参数解释** **：** 结束时间，格式为"yyyy-mm-ddThh:mm:ss.SSSSSZ"。 **取值范围** **：** 不涉及。 | | slow_query_threshold | Long | **参数解释** **：** 慢SQL阈值（单位：微秒）。 **取值范围** **：** 不涉及。 | | n_soft_parse | Long | **参数解释** **：** 软解析次数。 **取值范围** **：** 不涉及。 | | n_hard_parse | Long | **参数解释** **：** 硬解析次数。 **取值范围** **：** 不涉及。 | | query_plan | String | **参数解释** **：** 执行计划。 **取值范围** **：** 不涉及。 | | n_returned_rows | Long | **参数解释** **：** SELECT语句的返回结果集行数。 **取值范围** **：** 不涉及。 | | n_tuples_fetched | Long | **参数解释** **：** 随机扫描行。 **取值范围** **：** 不涉及。 | | n_tuples_returned | Long | **参数解释：** 顺序扫描行。 **取值范围** **：** 不涉及。 | | n_tuples_inserted | Long | **参数解释** **：** 插入行。 **取值范围** **：** 不涉及。 | | n_tuples_updated | Long | **参数解释** **：** 更新行。 **取值范围** **：** 不涉及。 | | n_tuples_deleted | Long | **参数解释** **：** 删除行。 **取值范围** **：** 不涉及。 | | n_blocks_fetched | Long | **参数解释** **：** buffer的块访问次数。 **取值范围**： 不涉及。 | | n_blocks_hit | Long | **参数解释** **：** buffer的块命中次数。 **取值范围**： 不涉及。 | | db_time | Long | **参数解释** **：** 有效DB时间花费（单位：微秒）。 **取值范围** **：** 不涉及。 | | cpu_time | Long | **参数解释** **：** CPU时间（单位：微秒）。 **取值范围** **：** 不涉及。 | | execution_time | Long | **参数解释** **：** 执行器内执行时间（单位：微秒）。 **取值范围** **：** 不涉及。 | | parse_time | Long | **参数解释** **：** SQL解析时间（单位：微秒）。 **取值范围** **：** 不涉及。 | | plan_time | Long | **参数解释** **：** SQL生成计划时间（单位：微秒）。 **取值范围** **：** 不涉及。 | | rewrite_time | Long | **参数解释** **：** SQL重写时间（单位：微秒）。 **取值范围** **：** 不涉及。 | | pl_execution_time | Long | **参数解释** **：** plpgsql上的执行时间（单位：微秒）。 **取值范围** **：** 不涉及。 | | pl_compilation_time | Long | **参数解释** **：** plpgsql上的编译时间（单位：微秒）。 **取值范围** **：** 不涉及。 | | data_io_time | Long | **参数解释** **：** IO时间（单位：微秒）。 **取值范围** **：** 不涉及。 | | lock_count | Long | **参数解释** **：** 加锁次数。 **取值范围** **：** 不涉及。 | | lock_time | Long | **参数解释** **：** 加锁耗时（单位：微秒）。 **取值范围** **：** 不涉及。 | | lock_wait_count | Long | **参数解释** **：** 加锁等待次数。 **取值范围** **：** 不涉及。 | | lock_wait_time | Long | **参数解释** **：** 加锁等待时间（单位：微秒）。 **取值范围** **：** 不涉及。 | | details | String | **参数解释** **：** 详细列表。 **取值范围** **：** 不涉及。 | | is_slow_sql | Boolean | **参数解释** **：** 是否慢SQL。 **取值范围** **：** 不涉及。 | | advise | String | **参数解释** **：** 可能导致该SQL为慢SQL的风险信息。 **取值范围** **：** 不涉及。 | | finish_status | String | **参数解释** **：** 语句完成状态。 **取值范围** **：** 不涉及。 | | net_send_info | String | **参数解释** **：** 通过物理连接发送消息的网络状态。 **取值范围** **：** 不涉及。 | | net_recv_info | String | **参数解释** **：** 通过物理连接接收消息的网络状态。 **取值范围** **：** 不涉及。 | | net_stream_send_info | String | **参数解释** **：** 通过逻辑连接发送消息的网络状态。 **取值范围** **：** 不涉及。 | | net_stream_recv_info | String | **参数解释** **：** 通过逻辑连接接收消息的网络状态。 **取值范围** **：** 不涉及。 | #### 请求示例 查询指定单条SQL记录的详情。 ``` GET https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3/4a89780fa1024361bcb855fed6aab89e/instances/cf9c879513144362bce2b3760ed81d3bin14/full-sqls/72620543991485094?sql_id=67570929&id=f084ca811d62f93af3dff2d508a981bc ``` #### 响应示例 ``` { "components": [ { "component_id": "cn_5001", "db_name": "postgres", "schema_name": "\"$user\",public", "origin_node": "1120683504", "username": "rdsAdmin", "application_name": "cm_agent", "client_addr": "127.0.0.1", "client_port": "57386", "parent_sql_id": "0", "sql_id": "2892486021", "sql_exec_id": "72620543998347760", "transaction_id": "0", "query": "SET query_dop = 1;", "sql": "", "thread_id": "139890949678656", "session_id": "139890949678656", "start_time": "2025-09-10T02:01:44.00000Z", "finish_time": "2025-09-10T02:01:44.00000Z", "slow_query_threshold": 0, "n_soft_parse": 0, "n_hard_parse": 0, "query_plan": "", "n_returned_rows": 0, "n_tuples_fetched": 0, "n_tuples_returned": 0, "n_tuples_inserted": 0, "n_tuples_updated": 0, "n_tuples_deleted": 0, "n_blocks_fetched": 0, "n_blocks_hit": 0, "db_time": 462, "cpu_time": 399, "execution_time": 0, "parse_time": 9, "plan_time": 0, "rewrite_time": 0, "pl_execution_time": 0, "pl_compilation_time": 0, "data_io_time": 0, "lock_count": 3, "lock_time": 0, "lock_wait_count": 0, "lock_wait_time": 0, "details": "{\"totalLen\":137,\"version\":2,\"events\":[{\"type\":\"IO\",\"name\":\"BufHashTableSearch\",\"duration\":5},{\"type\":\"STATE\",\"name\":\"flush data\",\"duration\":23},{\"type\":\"STATE\",\"name\":\"wait xact start command\",\"duration\":26},{\"type\":\"STATE\",\"name\":\"wait xact commit command\",\"duration\":29}]}", "is_slow_sql": true, "trace_id": "", "advise": "", "finish_status": "normal", "net_send_info": "{\"time\":30, \"n_calls\":2, \"size\":84}", "net_recv_info": "{\"time\":47, \"n_calls\":2, \"size\":53}", "net_stream_send_info": "{\"time\":0, \"n_calls\":0, \"size\":0}", "net_stream_recv_info": "{\"time\":0, \"n_calls\":0, \"size\":0}" } ], "trace_statistics": { "hit_rate": 0.0, "db_time": 462, "cpu_time": 399, "io_time": 0, "execution_time": 0, "scan_rows": 0, "update_rows": 0, "insert_rows": 0, "delete_rows": 0 } } ``` #### 状态码 - 正常 200 - 异常 请参见[状态码](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_194.html)。 #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_195.html)。