查询历史会话 - ListHistorySessions
调试
您可以在API Explorer中调试该接口。
授权信息
- 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
- 如果使用身份策略授权，需具备如下身份策略权限。
| 授权项 | 访问级别 | 资源类型（*为必须） | 条件键 | 别名 | 依赖的授权项 |
|---|---|---|---|---|---|
| rds:instance:getHistorySession | list | - | g:EnterpriseProjectId g:ResourceTag/<tag-key> | - | - |
接口约束
该接口仅支持RDS for PostgreSQL引擎。
URI
- URI格式
GET /v3/{project_id}/instances/{instance_id}/history-session?start_time={start_time}&end_time={end_time}
- 参数说明
表1 参数说明 名称
是否必选
说明
project_id
是
参数解释：
租户在某一region下的project ID。
获取方法请参见获取项目ID。
约束限制：
不涉及。
取值范围：
不涉及。
默认取值：
不涉及。
instance_id
是
参数解释：
实例ID。
约束限制：
不涉及。
取值范围：
不涉及。
默认取值：
不涉及。
pid
否
参数解释：
进程ID。
约束限制：
不涉及。
取值范围：
不涉及
默认取值：
不涉及。
user_name
否
参数解释：
用户名。
约束限制：
不涉及。
取值范围：
不涉及
默认取值：
不涉及。
database_name
否
参数解释：
数据库名。
约束限制：
不涉及。
取值范围：
不涉及
默认取值：
不涉及。
start_time
是
参数解释：
开始时间。
约束限制：
格式为UTC时间戳。
取值范围：
不涉及。
默认取值：
不涉及。
end_time
是
参数解释：
结束时间。
约束限制：
格式为UTC时间戳。
取值范围：
不涉及。
默认取值：
不涉及。
offset
否
参数解释：
索引位置,偏移量。从第一条数据偏移offset条数据后开始查询,值为0表示从第一条数据开始查询)。
约束限制：
必须为数字,不能为负数。
取值范围：
大于等于0的整数。
默认取值：
0
limit
否
参数解释：
查询记录数。
约束限制：
不涉及。
取值范围：
[1, 1000]
默认取值：
100
请求消息
无。
请求示例
查询历史会话。
GET https://{Endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/24c6678f474241fe89ee9c42f768022ein03/history-session?start_time=1764669600000&end_time=1765249000000 响应消息
- 正常响应要素说明
表2 要素说明 名称
参数类型
说明
total_count
Integer
参数解释：
总记录数。
取值范围：
不涉及。
sessions
Arrayofobjects
参数解释：
会话信息列表。
详情请参见表3。
表3 Session 名称
参数类型
说明
sample_time
String
参数解释：
采样时间。
取值范围：
不涉及。
blocked_process_id
String
参数解释：
阻塞进程ID。
取值范围：
不涉及。
database_oid
Integer
参数解释：
数据库OID。
取值范围：
不涉及。
database_name
String
参数解释：
数据库名。
取值范围：
不涉及。
session_id
Integer
参数解释：
会话ID。
取值范围：
不涉及。
parallel_leader_id
Integer
参数解释：
并行会话ID。
取值范围：
不涉及。
backend_user_oid
Integer
参数解释：
后端用户OID。
取值范围：
不涉及。
user_name
String
参数解释：
用户名。
取值范围：
不涉及。
app_name
String
参数解释：
应用名。
取值范围：
不涉及。
client_ip_address
String
参数解释：
客户端地址。
取值范围：
不涉及。
client_host_name
String
参数解释：
客户端名称。
取值范围：
不涉及。
client_port
Integer
参数解释：
客户端端口。
取值范围：
不涉及。
session_start_time
String
参数解释：
会话建立时间。
取值范围：
不涉及。
transaction_start_time
String
参数解释：
事务启动时间。
取值范围：
不涉及。
transaction_execution_time
Integer
参数解释：
事务执行时间(s)。
取值范围：
不涉及。
query_start_time
String
参数解释：
查询开始时间。
取值范围：
不涉及。
state_change_time
String
参数解释：
state改变时间。
取值范围：
不涉及。
wait_event_type
String
参数解释：
等待事件类型。
取值范围：
不涉及。
wait_event_name
String
参数解释：
等待事件名称。
取值范围：
不涉及。
session_status
String
参数解释：
会话状态。
取值范围：
不涉及。
backend_xid
Integer
参数解释：
Backend XID。
取值范围：
不涉及。
backend_xmin
Integer
参数解释：
Backend Xmin。
取值范围：
不涉及。
query_id
String
参数解释：
Query ID。
取值范围：
不涉及。
sql_statement
String
参数解释：
SQL语句。
取值范围：
不涉及。
process_type
String
参数解释：
进程类型。
取值范围：
不涉及。
memory_usage
Float
参数解释：
内存占比(%)。
取值范围：
不涉及。
process_status
String
参数解释：
进程状态。
取值范围：
不涉及。
cpu_usage
Float
参数解释：
3秒内平均CPU占用率(%)。
取值范围：
不涉及。
io_wait_status
Float
参数解释：
I/O等待时间(s)。
取值范围：
不涉及。
disk_read_rate
Float
参数解释：
磁盘读速率(MB/s)。
取值范围：
不涉及。
disk_write_rate
Float
参数解释：
磁盘写速率(MB/s)。
取值范围：
不涉及。
- 正常响应样例
{ "sessions" : [ { "sample_time" : "2025-12-02 18:03:27", "blocked_process_id" : "", "database_oid" : 5, "database_name" : "postgres", "session_id" : 16152, "backend_user_oid" : 16392, "user_name" : "rdsMetric", "app_name" : "", "client_port" : -1, "session_start_time" : "2025-12-01 15:57:34", "query_start_time" : "2025-12-02 18:03:24", "state_change_time" : "2025-12-02 18:03:24", "wait_event_type" : "Client", "wait_event_name" : "ClientRead", "session_status" : "idle", "query_id" : "134890507541751252", "sql_statement" : "select failed_count from pg_stat_archiver;", "process_type" : "client backend", "memory_usage" : 0.5593106, "process_status" : "sleeping", "cpu_usage" : 0, "io_wait_status" : 0, "disk_read_rate" : 0, "disk_write_rate" : 0 } ], "total_count" : 1 } - 异常响应
请参见异常响应结果。
状态码
- 正常
- 异常
请参见状态码。
错误码
请参见错误码。
