DescribeProcessStatsComposition - 查询会话信息_云数据库 OceanBase 版(OceanBase)-阿里云帮助中心

该接口用于查询会话信息。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
InstanceId	string	是	OceanBase 集群 ID。	ob317v4uif****
UId	string	否	OceanBase 数据库用户标识符。	139*************
TenantId	string	否	租户 ID。	t33h8y08k****
SqlText	string	否	SQL 语句，支持 LIKE 查询，可以只指定 SQL 语句的部分子句。	SELECT ** FROM WHERE = ? AND = ? ORDER BY ** ASC
ClientIp	string	否	客户端 IP。	127...*
ServerIp	string	否	服务器 IP。	127...*
Users	string	否	数据库用户名。	test1
Status	string	否	会话状态。	ACTIVE

返回参数

名称	类型	描述	示例值
	object	请求的返回结果。
RequestId	string	请求 ID。	EE205C00-30E4-**-**-87E3A8A2AA0C
Data	object	返回结果。
ObVersion	string	Ob 版本号

示例

正常返回示例

JSON格式

{
  "RequestId": "EE205C00-30E4-****-****-87E3A8A2AA0C",
  "Data": {
    "TotalSessionCount": 0,
    "ActiveSessionCount": 0,
    "IdleSessionCount": 0,
    "AllProcessList": [
      {
        "SqlText": "",
        "TenantId": "",
        "Database": "",
        "User": "",
        "ExecuteTime": 0,
        "CpuTime": 0,
        "ServerIp": "",
        "ClientIp": "",
        "SessionId": 0,
        "ProxySessId": "",
        "Command": "",
        "Status": "",
        "SqlId": "",
        "TraceId": "",
        "PlanId": ""
      }
    ],
    "SessionStatistics": {
      "UserStatistics": [
        {
          "MetricValue": "",
          "ActiveCount": 0,
          "TotalCount": 0,
          "Type": ""
        }
      ],
      "SourceStatistics": [
        {
          "MetricValue": "",
          "ActiveCount": 0,
          "TotalCount": 0,
          "Type": ""
        }
      ],
      "DataBaseStatistics": [
        {
          "MetricValue": "",
          "ActiveCount": 0,
          "TotalCount": 0,
          "Type": ""
        }
      ]
    },
    "ObVersion": ""
  }
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作
2024-05-27	OpenAPI 返回结构发生变更	查看变更详情