# 查询TOP SQL相关信息（SQL Server） - ListTopSqls #### 功能介绍 查询TOP SQL相关信息。 - 调用接口前，您需要了解API[认证鉴权](https://support.huaweicloud.com/api-rds/rds_03_0001.html)。 - 调用接口前，您需要了解[请求Header参数说明](https://support.huaweicloud.com/api-rds/rds_03_0005.html#rds_03_0005__section479119143310)。 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/RDS/doc?api=ListTopSqls)中调试该接口。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-rds/rds_10_0005.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | rds:instance:listAll | read | - | - | rds:instance:list | - | #### URI - URI格式 GET /v3/{project_id}/instances/{instance_id}/top-sqls - 参数说明 表1参数说明 | 名称 | 是否必选 | 参数类型 | 说明 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释：** 租户在某一region下的project ID。 获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-rds/rds_03_0002.html)。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | instance_id | 是 | String | **参数解释：** 实例ID。 可调用[查询数据库实例列表](https://support.huaweicloud.com/api-rds/rds_01_0004.html)接口，通过[表4](https://support.huaweicloud.com/api-rds/rds_01_0004.html#rds_01_0004__table2058713718267)中的"id"获取。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | 表2请求参数 | 名称 | 是否必选 | 参数类型 | 说明 | |:---|:---|:---|:---| | sort_key | 否 | String | **参数解释：** 排序字段。 **约束限制：** 不涉及。 **取值范围：** - avg_cpu_time：平均CPU耗时。 - total_cpu_time：总CPU耗时。 - total_duration_time：总执行时间。 - avg_duration_time：平均执行时间。 - total_rows：总行数。 - avg_rows：平均行数。 - total_logical_reads：总逻辑读。 - avg_logical_reads：平均逻辑读。 **默认取值：** 不涉及。 | | limit | 否 | Integer | **参数解释：** TOP数量。 **约束限制：** 不涉及。 **取值范围：** 最大支持15个。 **默认取值：** 不涉及。 | | statement | 否 | String | **参数解释：** 搜索文本内容。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | sort_dir | 否 | String | **参数解释：** 排序规则。 **约束限制：** 不涉及。 **取值范围：** - desc：降序。 - asc：升序。 **默认取值：** 默认降序。 | #### 请求消息 无。 #### 请求示例 查询SQL Server TOP SQL相关信息。 ``` GET https://{Endpoint}/v3/1783d762a2c7416c817810224d01ca22/instances/8862f0a6de6c4b4eaa35abe435f4edccin04/top-sqls?limit=1 ``` #### 响应消息 - 正常响应要素说明 表3要素说明 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | total_count | Integer | **参数解释：** 总数。 **取值范围：** 不涉及。 | | list | Array of objects | **参数解释：** TOP SQL 信息列表，详见[表4]。 | | avg_cpu_time_top_values | Array of objects | **参数解释：** 平均CPU开销TOP SQL列表，详见[表5]。 | | avg_duration_time_top_values | Array of objects | **参数解释：** 平均执行耗时TOP SQL列表，详见[表5]。 | | avg_rows_top_values | Array of objects | **参数解释：** 平均返回行TOP SQL列表，详见[表6]。 | | avg_logical_top_values | Array of objects | **参数解释：** 平均逻辑读TOP SQL列表，详见[表7]。 | | total_cpu_time_top_values | Array of objects | **参数解释：** 总CPU开销TOP SQL列表，详见[表5]。 | | total_duration_time_top_values | Array of objects | **参数解释：** 总执行耗时TOP SQL列表，详见[表5]。 | | total_rows_top_values | Array of objects | **参数解释：** 总返回行TOP SQL列表，详见[表6]。 | | total_logical_reads_top_values | Array of objects | **参数解释：** 总逻辑读TOP SQL列表，详见[表7]。 | 表4list字段说明 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | **参数解释：** 对查询计算的二进制哈希值，用于标识具有类似逻辑的查询。 **取值范围：** 不涉及。 | | statement | String | **参数解释：** 当前执行的SQL语句。 **取值范围：** 不涉及。 | | query | String | **参数解释：** SQL全文。 **取值范围：** 不涉及。 | | db_name | String | **参数解释：** 数据库名称。 **取值范围：** 不涉及。 | | execution_count | String | **参数解释：** 执行总次数。 **取值范围：** 不涉及。 | | execution_count_percent | String | **参数解释：** 执行总次数百分比。 **取值范围：** 范围0.0000\~1.0000。 | | total_cpu_time | String | **参数解释：** 总CPU耗时，单位ms。 **取值范围：** 不涉及。 | | total_cpu_time_percent | String | **参数解释：** 总CPU耗时百分比。 **取值范围：** 范围0.0000\~1.0000。 | | avg_cpu_time | String | **参数解释：** 平均CPU耗时，单位ms。 **取值范围：** 不涉及。 | | avg_cpu_time_percent | String | **参数解释：** 平均CPU耗时百分比。 **取值范围：** 范围0.0000\~1.0000。 | | total_duration_time | String | **参数解释：** 总执行耗时。 **取值范围：** 不涉及。 | | total_duration_time_percent | String | **参数解释：** 总执行耗时百分比。 **取值范围：** 范围0.0000\~1.0000。 | | avg_duration_time | String | **参数解释：** 平均执行耗时。 **取值范围：** 不涉及。 | | avg_duration_time_percent | String | **参数解释：** 平均执行耗时百分比。 **取值范围：** 范围0.0000\~1.0000。 | | total_rows | String | **参数解释：** 总返回行。 **取值范围：** 不涉及。 | | total_rows_percent | String | **参数解释：** 总返回行百分比。 **取值范围：** 范围0.0000\~1.0000。 | | avg_rows | String | **参数解释：** 平均返回行。 **取值范围：** 不涉及。 | | avg_rows_percent | String | **参数解释：** 平均返回行百分比。 **取值范围：** 范围0.0000\~1.0000。 | | total_logical_reads | String | **参数解释：** 总逻辑读消耗。 **取值范围：** 不涉及。 | | total_logical_reads_percent | String | **参数解释：** 总逻辑读百分比。 **取值范围：** 范围0.0000\~1.0000。 | | avg_logical_reads | String | **参数解释：** 平均逻辑读消耗。 **取值范围：** 不涉及。 | | avg_logical_reads_percent | String | **参数解释：** 平均逻辑读百分比。 **取值范围：** 范围0.0000\~1.0000。 | | avg_logical_write | String | **参数解释：** 平均逻辑写消耗。 **取值范围：** 不涉及。 | | avg_logical_write_percent | String | **参数解释：** 平均逻辑写百分比。 **取值范围：** 范围0.0000\~1.0000。 | | total_logical_write | String | **参数解释：** 总逻辑写消耗。 **取值范围：** 不涉及。 | | total_logical_write_percent | String | **参数解释：** 总逻辑写百分比。 **取值范围：** 范围0.0000\~1.0000。 | | avg_physical_reads | String | **参数解释：** 平均物理读消耗。 **取值范围：** 不涉及。 | | avg_physical_reads_percent | String | **参数解释：** 平均物理读百分比。 **取值范围：** 范围0.0000\~1.0000。 | | total_physical_reads | String | **参数解释：** 总物理读消耗。 **取值范围：** 不涉及。 | | total_physical_reads_percent | String | **参数解释：** 总物理读百分比。 **取值范围：** 范围0.0000\~1.0000。 | | last_execution_time | String | **参数解释：** 上次执行时间。 **取值范围：** 不涉及。 | 表5TopSqlsTimeResult | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | **参数解释：** 对查询计算的二进制哈希值，用于标识具有类似逻辑的查询。 **取值范围：** 不涉及。 | | data_type | String | **参数解释：** 数据类型。 **取值范围：** - AvgWorkerTime：平均CPU开销。 - AvgDuration：平均执行耗时。 - TotalWorkerTime：总CPU开销。 - TotalDuration：总执行耗时。 | | value | String | **参数解释：** 耗时时间，单位ms。 | 表6TopSqlsRowResult | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | **参数解释：** 对查询计算的二进制哈希值，用于标识具有类似逻辑的查询。 **取值范围：** 不涉及。 | | data_type | String | **参数解释：** 数据类型。 **取值范围：** - AvgReturnRows：平均返回行。 - TotalReturnRows：总返回行。 | | value | String | **参数解释：** 行数。 **取值范围：** 不涉及。 | 表7TopSqlsLogicalReadResult | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | **参数解释：** 对查询计算的二进制哈希值，用于标识具有类似逻辑的查询。 **取值范围：** 不涉及。 | | data_type | String | **参数解释：** 数据类型。 **取值范围：** - AvgLogicalReads：平均逻辑读。 - TotalLogicalReads：总逻辑读。 | | value | String | **参数解释：** 逻辑读消耗。 **取值范围：** 不涉及。 | - 正常响应样例 ``` { "total_count" : 1, "list" : [ { "id" : "0xb1a8d62fcf665755", "statement" : "select * from ::fn_trace_getinfo(default)", "query" : "select * from ::fn_trace_getinfo(default)", "db_name" : "test", "execution_count" : "1", "execution_count_percent" : "1.0000", "total_cpu_time" : "294", "total_cpu_time_percent" : "1.0000", "avg_cpu_time" : "294.98", "avg_cpu_time_percent" : "0.9999", "total_duration_time" : "779", "total_duration_time_percent" : "1.0000", "avg_duration_time" : "779.92", "avg_duration_time_percent" : "1.0000", "total_rows" : "134", "total_rows_percent" : "1.0000", "avg_rows" : "134.00", "avg_rows_percent" : "1.0000", "total_logical_reads" : "75564", "total_logical_reads_percent" : "1.0000", "avg_logical_reads" : "75564.00", "avg_logical_reads_percent" : "1.0000", "total_physical_reads" : "1083", "total_physical_reads_percent" : "1.0000", "avg_physical_reads" : "1083.00", "avg_physical_reads_percent" : "1.0000", "total_logical_write" : "41", "total_logical_write_percent" : "1.0000", "avg_logical_write" : "41.00", "avg_logical_write_percent" : "1.0000", "last_execution_time" : "2025-08-03 10:49:02.267" } ], "avg_cpu_time_top_values" : [ { "id" : "0xb1a8d62fcf665755", "data_type" : "AvgWorkerTime", "value" : "294.98" } ], "avg_duration_time_top_values" : [ { "id" : "0xd9bfe0aeb1b674bf", "data_type" : "AvgDuration", "value" : "968.88" } ], "avg_rows_top_values" : [ { "id" : "0xe2d481769b70e309", "data_type" : "AvgReturnRows", "value" : "1428.00" } ], "avg_logical_top_values" : [ { "id" : "0xe2d481769b70e309", "data_type" : "AvgLogicalReads", "value" : "81663.00" } ], "total_cpu_time_top_values" : [ { "id" : "0xcb9a020ae719df11", "data_type" : "TotalWorkerTime", "value" : "988334.79" } ], "total_duration_time_top_values" : [ { "id" : "0xcb9a020ae719df11", "data_type" : "TotalDuration", "value" : "1003770.19" } ], "total_rows_top_values" : [ { "id" : "0x84798563b8b1721c", "data_type" : "TotalReturnRows", "value" : "1742768.00" } ], "total_logical_reads_top_values" : [ { "id" : "0xcb9a020ae719df11", "data_type" : "TotalLogicalReads", "value" : "50701726.00" } ] } ``` - 异常响应 请参见[异常响应结果](https://support.huaweicloud.com/api-rds/rds_01_0010.html)。 #### 状态码 - 正常 200 - 异常 请参见[状态码](https://support.huaweicloud.com/api-rds/rds_10_0200.html)。 #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-rds/rds_10_0201.html)。