查询历史TOP SQL（瞬时） - ListHistoryTopSqls
调试
您可以在API Explorer中调试该接口。
授权信息
- 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
- 如果使用身份策略授权，需具备如下身份策略权限。
| 授权项 | 访问级别 | 资源类型（*为必须） | 条件键 | 别名 | 依赖的授权项 |
|---|---|---|---|---|---|
| rds:instance:getTopSql | list | - | g:EnterpriseProjectId g:ResourceTag/<tag-key> | - | - |
接口约束
该接口仅支持RDS for PostgreSQL引擎。
URI
- URI格式
GET /v3/{project_id}/instances/{instance_id}/history-top-sql?start_time={start_time}&end_time={end_time}
- 参数说明
表1 参数说明 名称
是否必选
说明
project_id
是
参数解释：
租户在某一region下的project ID。
获取方法请参见获取项目ID。
约束限制：
不涉及。
取值范围：
不涉及。
默认取值：
不涉及。
instance_id
是
参数解释：
实例ID。
约束限制：
不涉及。
取值范围：
不涉及。
默认取值：
不涉及。
user_name
否
参数解释：
用户名。
约束限制：
不涉及。
取值范围：
不涉及
默认取值：
不涉及。
database_name
否
参数解释：
数据库名。
约束限制：
不涉及。
取值范围：
不涉及
默认取值：
不涉及。
start_time
是
参数解释：
开始时间。
约束限制：
格式为UTC时间戳。
取值范围：
不涉及
默认取值：
不涉及。
end_time
是
参数解释：
结束时间。
约束限制：
格式为UTC时间戳。
取值范围：
不涉及
默认取值：
不涉及。
offset
否
参数解释：
索引位置,偏移量。从第一条数据偏移offset条数据后开始查询,值为0表示从第一条数据开始查询)。
约束限制：
必须为数字,不能为负数。
取值范围：
大于等于0的整数。
默认取值：
0。
limit
否
参数解释：
查询记录数。
约束限制：
不涉及。
取值范围：
[1, 1000]
默认取值：
100
请求消息
无。
请求示例
查询历史TOP SQL（瞬时）。
GET https://{Endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/24c6678f474241fe89ee9c42f768022ein03/history-top-sql?start_time=1764669600000&end_time=1765249000000 响应消息
- 正常响应要素说明
表2 要素说明 名称
参数类型
说明
total_count
Integer
参数解释：
总记录数。
取值范围：
不涉及。
top_sqls
Array of objects
参数解释：
TOP SQL列表。
详情请参见表3。
- 正常响应样例
{ "top_sqls" : [ { "sample_time" : "2025-12-02 18:03:27", "count" : 1, "database_name" : "", "user_name" : "", "sql_statement" : "", "query_id" : "" } ], "total_count" : 1 } - 异常响应
请参见异常响应结果。
状态码
- 正常
- 异常
请参见状态码。
错误码
请参见错误码。
