该接口用于查询会话信息。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| oceanbase:DescribeProcessStatsComposition | get | *Instance acs:oceanbase:{#regionId}:{#accountId}:instance/{#InstanceId} |
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| InstanceId | string | 是 | OceanBase 集群 ID。 | ob******** |
| UId | string | 否 | OceanBase 数据库用户标识符。 | 139************* |
| TenantId | string | 否 | 租户 ID，必填选项。 | t******** |
| SqlText | string | 否 | SQL 语句，支持 LIKE 查询，可以只指定 SQL 语句的部分子句。 | SELECT **** FROM **** WHERE **** = ? AND **** = ? ORDER BY **** ASC |
| ClientIp | string | 否 | 客户端 IP。 | 127.*.*.* |
| ServerIp | string | 否 | 服务器 IP。 | 127.*.*.* |
| Users | string | 否 | 数据库用户名。 | ["test_user"] |
| Status | string | 否 | 会话状态。 | ACTIVE |
| MergeDynamicSql | boolean | 否 | 返回结果时，是否合并动态 SQL。 说明
表示输出结果时，是否聚合 in 查询的 SQL 的结果。 | false |
返回参数
示例
正常返回示例
JSON格式
{
"RequestId": "EE205C00-30E4-****-****-87E3A8A2AA0C",
"Data": {
"TotalSessionCount": 100,
"ActiveSessionCount": 60,
"IdleSessionCount": 30,
"AllProcessList": [
{
"SqlText": "select * from c1 where id = 100;",
"TenantId": "t********",
"Database": "c1",
"User": "test_user",
"ExecuteTime": 5,
"CpuTime": 1,
"ServerIp": "xx.xx.xx.xx",
"ClientIp": "xx.xx.xx.xx",
"SessionId": 0,
"ProxySessId": "7521015416********",
"Command": "Query",
"Status": "ACTIVE",
"SqlId": "45CCBDC7DEBDCDAXXXXAFC********",
"TraceId": "YB420XXX128-00062XXXX8313XXX1-X-X",
"PlanId": 1898,
"DynamicSql": false,
"ProcessSqlLists": [
{
"SqlText": "select * from c1 where id = 100;",
"TenantId": "t********",
"Database": "c2",
"User": "test_user",
"ExecuteTime": 5,
"CpuTime": 1,
"ServerIp": "xx.xx.xx.xx",
"ClientIp": "xx.xx.xx.xx",
"SessionId": 0,
"ProxySessId": "7521015416********",
"Command": "Query",
"Status": "ACTIVE",
"SqlId": "45CCBDC7DEBDCDAXXXXAFC********",
"TraceId": "YB420XXX128-00062XXXX8313XXX1-X-X",
"PlanId": 1898,
"DynamicSql": false,
"ProcessSqlList": [
{
"SqlText": "select * from c1 where id = 100;",
"TenantId": "t********",
"Database": "c3",
"User": "test_user",
"ExecuteTime": 5,
"CpuTime": 1,
"ServerIp": "xx.xx.xx.xx",
"ClientIp": "xx.xx.xx.xx",
"SessionId": 0,
"ProxySessId": "7521015416********",
"Command": "Query",
"Status": "ACTIVE",
"SqlId": "45CCBDC7DEBDCDAXXXXAFC********\n",
"TraceId": "YB420XXX128-00062XXXX8313XXX1-X-X",
"PlanId": 1898,
"DynamicSql": false
}
]
}
],
"ServerSn": "i-bp1*****sw64dhb*****"
}
],
"SessionStatistics": {
"UserStatistics": [
{
"MetricValue": "test_user",
"ActiveCount": 25,
"TotalCount": 30,
"Type": "user"
}
],
"SourceStatistics": [
{
"MetricValue": "xx.xx.xx.xx",
"ActiveCount": 25,
"TotalCount": 30,
"Type": "client"
}
],
"DataBaseStatistics": [
{
"MetricValue": "test_database",
"ActiveCount": 25,
"TotalCount": 30,
"Type": "database"
}
]
},
"ObVersion": "3.2.4"
}
}错误码
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2025-07-11 | OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2025-07-08 | OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2025-04-22 | OpenAPI 入参发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2024-05-27 | OpenAPI 返回结构发生变更 | 查看变更详情 |