文档首页/ 云数据库 RDS/ API参考/ API v3（推荐）/ 管理数据库和用户（SQL Server）/ 查询top对象信息 - ShowTopObjects
更新时间：2026-08-06 GMT+08:00
查看PDF
分享

查询top对象信息 - ShowTopObjects

功能介绍

查询指定实例中数据库的查询top对象信息。

调试

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

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，需具备如下身份策略权限。

授权项

访问级别

资源类型（*为必须）

条件键

别名

依赖的授权项

rds:instance:get

read

instance

-

rds:instance:list

-

URI

  • URI格式

    GET /v3/{project_id}/instances/{instance_id}/ops/top/objects

  • 参数说明
    表1 参数说明

    参数

    是否必选

    参数类型

    描述

    project_id

    是

    String

    参数解释：

    租户在某一region下的project ID。

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

    约束限制：

    不涉及。

    取值范围：

    不涉及。

    默认取值：

    不涉及。

    instance_id

    是

    String

    参数解释：

    实例ID。

    可调用查询数据库实例列表接口，通过表4中的“id”获取。

    约束限制：

    不涉及。

    取值范围：

    不涉及。

    默认取值：

    不涉及。

请求消息

表2 参数说明

参数

是否必选

参数类型

描述

top

否

Integer

参数解释：

top行数。

约束限制：

不涉及。

取值范围：

  • 5
  • 10
  • 15

默认取值：

10

database_name

否

String

参数解释：

数据库名。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

order

否

String

参数解释：

排序规则

约束限制：

不涉及。

取值范围：

  • total_elapsed_time：总执行耗时。
  • total_worker_time：总cpu耗时。
  • total_logical_reads：总逻辑读。
  • total_logical_writes：总逻辑写。
  • total_physical_reads：总物理读。
  • total_rows：总行数。

默认取值：

total_elapsed_time

请求示例

查询指定实例中数据库的查询top对象信息。

GET https://{endpoint}/v3/5a7a69c429aa41b8a565c9a4995afea0/instances/a7cd8ced1bcd4de88770dbda1f24f0f7in04/ops/top/objects?top=1&order=total_worker_time&database_name=test

响应消息

  • 正常响应要素说明
    表3 要素说明

    参数

    参数类型

    描述

    cur_time

    Integer

    参数解释：

    更新时间，使用毫秒时间戳。

    取值范围：

    不涉及。

    top_object_list

    Array of objects

    参数解释：

    top对象明细。

    详见表4。

    top_object_overview_list

    Array of objects

    参数解释：

    top对象总览。

    详见表5。
    表4 top_object_list字段说明

    参数

    参数类型

    描述

    row_id

    String

    参数解释：

    仅表示行序号。

    取值范围：

    不涉及。

    database_name

    String

    参数解释：

    数据库名称。

    取值范围：

    不涉及。

    schema_name

    String

    参数解释：

    schema名称。

    取值范围：

    不涉及。

    object_name

    String

    参数解释：

    对象名称。

    取值范围：

    不涉及。

    object_id

    String

    参数解释：

    对象ID。

    取值范围：

    不涉及。

    object_type

    String

    参数解释：

    对象类型。

    取值范围：

    • SQL_TRIGGER：SQL触发器。
    • SQL_STORED_PROCEDURE：SQL存储过程。
    • SQL_VIEW：SQL视图。

    sql_statement

    String

    参数解释：

    SQL文本。

    取值范围：

    不涉及。

    execution_count

    String

    参数解释：

    执行次数。

    取值范围：

    不涉及。

    plan_generation_num

    String

    参数解释：

    获取执行计划次数。

    取值范围：

    不涉及。

    last_execution_time

    String

    参数解释：

    最近执行时间。

    取值范围：

    不涉及。

    avg_worker_time

    String

    参数解释：

    平均CPU耗时，单位为毫秒。

    取值范围：

    不涉及。

    total_worker_time

    String

    参数解释：

    总CPU耗时，单位为毫秒。

    取值范围：

    不涉及。

    last_worker_time

    String

    参数解释：

    最近CPU耗时，单位为毫秒。

    取值范围：

    不涉及。

    min_worker_time

    String

    参数解释：

    最小CPU耗时，单位为毫秒。

    取值范围：

    不涉及。

    max_worker_time

    String

    参数解释：

    最大CPU耗时，单位为毫秒。

    取值范围：

    不涉及。

    avg_logical_reads

    String

    参数解释：

    平均逻辑读。逻辑页，一页等于8KB。

    取值范围：

    不涉及。

    total_logical_reads

    String

    参数解释：

    总共逻辑读。逻辑页，一页等于8KB。

    取值范围：

    不涉及。

    last_logical_reads

    String

    参数解释：

    最近逻辑读。逻辑页，一页等于8KB。

    取值范围：

    不涉及。

    min_logical_reads

    String

    参数解释：

    最小逻辑读。逻辑页，一页等于8KB。

    取值范围：

    不涉及。

    max_logical_reads

    String

    参数解释：

    最大逻辑读。逻辑页，一页等于8KB。

    取值范围：

    不涉及。

    avg_logical_writes

    String

    参数解释：

    平均逻辑写。逻辑页，一页等于8KB。

    取值范围：

    不涉及。

    total_logical_writes

    String

    参数解释：

    总共逻辑写。逻辑页，一页等于8KB。

    取值范围：

    不涉及。

    last_logical_writes

    String

    参数解释：

    最近逻辑写。逻辑页，一页等于8KB。

    取值范围：

    不涉及。

    min_logical_writes

    String

    参数解释：

    最小逻辑写。逻辑页，一页等于8KB。

    取值范围：

    不涉及。

    max_logical_writes

    String

    参数解释：

    最大逻辑写。逻辑页，一页等于8KB。

    取值范围：

    不涉及。

    avg_logical_io

    String

    参数解释：

    平均逻辑IO。逻辑页，一页等于8KB。

    取值范围：

    不涉及。

    total_logical_io

    String

    参数解释：

    总共逻辑IO。逻辑页，一页等于8KB。

    取值范围：

    不涉及。

    last_logical_io

    String

    参数解释：

    最近逻辑IO。逻辑页，一页等于8KB。

    取值范围：

    不涉及。

    min_logical_io

    String

    参数解释：

    最小逻辑IO。逻辑页，一页等于8KB。

    取值范围：

    不涉及。

    max_logical_io

    String

    参数解释：

    最大逻辑IO。逻辑页，一页等于8KB。

    取值范围：

    不涉及。

    avg_physical_reads

    String

    参数解释：

    平均物理读。逻辑页，一页等于8KB。

    取值范围：

    不涉及。

    total_physical_reads

    String

    参数解释：

    总共物理读。逻辑页，一页等于8KB。

    取值范围：

    不涉及。

    last_physical_reads

    String

    参数解释：

    最近物理读。逻辑页，一页等于8KB。

    取值范围：

    不涉及。

    min_physical_reads

    String

    参数解释：

    最小物理读。逻辑页，一页等于8KB。

    取值范围：

    不涉及。

    max_physical_reads

    String

    参数解释：

    最大物理读。逻辑页，一页等于8KB。

    取值范围：

    不涉及。

    avg_elapsed_time

    String

    参数解释：

    平均执行耗时，单位为毫秒。

    取值范围：

    不涉及。

    total_elapsed_time

    String

    参数解释：

    总共执行耗时，单位为毫秒。

    取值范围：

    不涉及。

    last_elapsed_time

    String

    参数解释：

    最近执行耗时，单位为毫秒。

    取值范围：

    不涉及。

    min_elapsed_time

    String

    参数解释：

    最小执行耗时，单位为毫秒。

    取值范围：

    不涉及。

    max_elapsed_time

    String

    参数解释：

    最大执行耗时，单位为毫秒。

    取值范围：

    不涉及。

    avg_rows

    String

    参数解释：

    平均返回行。

    取值范围：

    不涉及。

    total_rows

    String

    参数解释：

    总返回行。

    取值范围：

    不涉及。

    last_rows

    String

    参数解释：

    最近返回行。

    取值范围：

    不涉及。

    min_rows

    String

    参数解释：

    最小返回行。

    取值范围：

    不涉及。

    max_rows

    String

    参数解释：

    最大返回行。

    取值范围：

    不涉及。
    表5 top_object_overview_list字段说明

    参数

    参数类型

    描述

    avg_cpu_time

    Double

    参数解释：

    平均CPU耗时，单位为毫秒。

    取值范围：

    不涉及。

    avg_cpu_time_percentage

    Double

    参数解释：

    平均CPU耗时百分比。

    取值范围：

    不涉及。

    avg_execution_time

    Double

    参数解释：

    平均执行耗时，单位为毫秒。

    取值范围：

    不涉及。

    avg_execution_time_percentage

    Double

    参数解释：

    平均执行耗时百分比。

    取值范围：

    不涉及。

    avg_logical_io

    Double

    参数解释：

    平均逻辑IO。逻辑页，一页等于8KB。

    取值范围：

    不涉及。

    avg_logical_io_percentage

    Double

    参数解释：

    平均逻辑IO百分比。

    取值范围：

    不涉及。

    avg_logical_reads

    Double

    参数解释：

    平均逻辑读。逻辑页，一页等于8KB。

    取值范围：

    不涉及。

    avg_logical_reads_percentage

    Double

    参数解释：

    平均逻辑读百分比。

    取值范围：

    不涉及。

    avg_logical_writes

    Double

    参数解释：

    平均逻辑写。逻辑页，一页等于8KB。

    取值范围：

    不涉及。

    avg_logical_writes_percentage

    Double

    参数解释：

    平均逻辑写百分比。

    取值范围：

    不涉及。

    avg_physical_reads

    Double

    参数解释：

    平均物理读。逻辑页，一页等于8KB。

    取值范围：

    不涉及。

    avg_physical_reads_percentage

    Double

    参数解释：

    平均物理读百分比。

    取值范围：

    不涉及。

    avg_rows

    Double

    参数解释：

    平均返回行。

    取值范围：

    不涉及。

    avg_rows_percentage

    Double

    参数解释：

    平均返回行百分比。

    取值范围：

    不涉及。

    database_name

    String

    参数解释：

    数据库名称。

    取值范围：

    不涉及。

    object_id

    String

    参数解释：

    对象ID。

    取值范围：

    不涉及。

    object_name

    String

    参数解释：

    对象名称。

    取值范围：

    不涉及。

    row_id

    String

    参数解释：

    仅表示行序号。

    取值范围：

    不涉及。

    object_type

    String

    参数解释：

    对象类型。

    取值范围：

    不涉及。

    schema_name

    String

    参数解释：

    schema名称。

    取值范围：

    不涉及。

    total_cpu_time

    Double

    参数解释：

    总CPU耗时，单位为毫秒。

    取值范围：

    不涉及。

    total_cpu_time_percentage

    Double

    参数解释：

    总CPU耗时百分比。

    取值范围：

    不涉及。

    total_execution_time

    Double

    参数解释：

    总执行耗时，单位为毫秒。

    取值范围：

    不涉及。

    total_execution_time_percentage

    Double

    参数解释：

    总执行耗时百分比。

    取值范围：

    不涉及。

    total_execution_count

    Double

    参数解释：

    总执行次数。

    取值范围：

    不涉及。

    total_logical_io

    Double

    参数解释：

    总逻辑IO。

    取值范围：

    不涉及。

    total_logical_io_percentage

    Double

    参数解释：

    总逻辑IO百分比。

    取值范围：

    不涉及。

    total_logical_reads

    Double

    参数解释：

    总逻辑读。

    取值范围：

    不涉及。

    total_logical_reads_percentage

    Double

    参数解释：

    总逻辑读百分比。

    取值范围：

    不涉及。

    total_logical_writes

    Double

    参数解释：

    总逻辑写。

    取值范围：

    不涉及。

    total_logical_writes_percentage

    Double

    参数解释：

    总逻辑写百分比。

    取值范围：

    不涉及。

    total_physical_reads

    Double

    参数解释：

    总物理读。

    取值范围：

    不涉及。

    total_physical_reads_percentage

    Double

    参数解释：

    总物理读百分比。

    取值范围：

    不涉及。

    total_rows

    Double

    参数解释：

    总返回行。

    取值范围：

    不涉及。

    total_rows_percentage

    Double

    参数解释：

    总返回行百分比。

    取值范围：

    不涉及。
  • 正常响应样例 
    {
  "cur_time": 1784795293536,
  "top_object_list": [
    {
      "row_id": "1",
      "database_name": "test",
      "schema_name": "dbo",
      "object_name": "test",
      "object_id": "1285579618",
      "object_type": "SQL_STORED_PROCEDURE",
      "sql_statement": "SELECT TOP (1000) [id]\r\n      ,[name]\r\n      ,[birdate]\r\n      ,[tel]\r\n      ,[note]\r\n  FROM [test].[dbo].[test0103a]",
      "execution_count": "3",
      "plan_generation_num": "1",
      "last_execution_time": "2026-07-23 16:28:03",
      "avg_worker_time": "0.07",
      "total_worker_time": "0.224",
      "last_worker_time": "0.045",
      "min_worker_time": "0.045",
      "max_worker_time": "0.131",
      "avg_logical_reads": "0.00",
      "total_logical_reads": "0",
      "last_logical_reads": "0",
      "min_logical_reads": "0",
      "max_logical_reads": "0",
      "avg_logical_writes": "0.00",
      "total_logical_writes": "0",
      "last_logical_writes": "0",
      "min_logical_writes": "0",
      "max_logical_writes": "0",
      "avg_logical_io": "0.00",
      "total_logical_io": "0",
      "last_logical_io": "0",
      "min_logical_io": "0",
      "max_logical_io": "0",
      "avg_physical_reads": "0.00",
      "total_physical_reads": "0",
      "last_physical_reads": "0",
      "min_physical_reads": "0",
      "max_physical_reads": "0",
      "avg_elapsed_time": "0.08",
      "total_elapsed_time": "0.231",
      "last_elapsed_time": "0.048",
      "min_elapsed_time": "0.048",
      "max_elapsed_time": "0.133",
      "avg_rows": "0.00",
      "total_rows": "0",
      "last_rows": "0",
      "min_rows": "0",
      "max_rows": "0"
    }
  ],
  "top_object_overview_list": [
    {
      "avg_cpu_time": 0.07,
      "avg_cpu_time_percentage": 1.0,
      "avg_execution_time": 0.08,
      "avg_execution_time_percentage": 1.0,
      "avg_logical_io": 0.0,
      "avg_logical_io_percentage": 0.0,
      "avg_logical_reads": 0.0,
      "avg_logical_reads_percentage": 0.0,
      "avg_logical_writes": 0.0,
      "avg_logical_writes_percentage": 0.0,
      "avg_physical_reads": 0.0,
      "avg_physical_reads_percentage": 0.0,
      "avg_rows": 0.0,
      "avg_rows_percentage": 0.0,
      "database_name": "test",
      "object_id": "1285579618",
      "object_name": "test",
      "row_id": "1",
      "object_type": "SQL_STORED_PROCEDURE",
      "schema_name": "dbo",
      "total_cpu_time": 0.224,
      "total_cpu_time_percentage": 1.0,
      "total_execution_time": 0.231,
      "total_execution_time_percentage": 1.0,
      "total_execution_count": 3.0,
      "total_logical_io": 0.0,
      "total_logical_io_percentage": 0.0,
      "total_logical_reads": 0.0,
      "total_logical_reads_percentage": 0.0,
      "total_logical_writes": 0.0,
      "total_logical_writes_percentage": 0.0,
      "total_physical_reads": 0.0,
      "total_physical_reads_percentage": 0.0,
      "total_rows": 0.0,
      "total_rows_percentage": 0.0
    }
  ]
}
  • 异常响应

    请参见异常响应结果。

状态码

错误码

请参见错误码。

相关文档