DescribeProcessStatsComposition - ApsaraDB for OceanBase

You can call this operation to query session information.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
oceanbase:DescribeProcessStatsComposition	get	Instance acs:oceanbase:{#regionId}:{#accountId}:instance/{#InstanceId}	none	none

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The ID of the OceanBase cluster.	ob317v4uif****
UId	string	No	The user identifier (UID) of OceanBase Database.	139*************
TenantId	string	No	The ID of the tenant.	t33h8y08k****
SqlText	string	No	The SQL statement. It supports LIKE clauses, and you may specify only part of the clauses in the SQL statement.	SELECT ** FROM WHERE = ? AND = ? ORDER BY ** ASC
ClientIp	string	No	The IP address of the client.	127...*
ServerIp	string	No	The IP address of the server.	127...*
Users	string	No	The username that you use to log in to the database.	test1
Status	string	No	The state of the session.	ACTIVE

Response parameters

Parameter	Type	Description	Example
	object	The return result of the request.
RequestId	string	The ID of the request.	EE205C00-30E4-**-**-87E3A8A2AA0C
Data	array<object>	The return result.
	object	The return result.
TotalSessionCount	integer	The total number of sessions.	500
ActiveSessionCount	integer	The number of active sessions.	25
IdleSessionCount	integer	The number of idle sessions.	8
AllProcessList	array<object>	The list of all processes in the system.
	object	The return result of the request.
SqlText	string	The SQL statement.	SELECT * FROM table_name;
TenantId	string	The ID of the tenant.	t33h8y08k****
Database	string	The name of the database.	database1
User	string	The username that you use to log in to the database.	test1
ExecuteTime	long	The execution time.	18.23
CpuTime	long	The CPU time.	257.943
ServerIp	string	The IP address of the server.	127...*
ClientIp	string	The IP address of the client.	127...*
SessionId	long	The ID of the session.	1***************90L
ProxySessId	string	The ID of the proxy session.	ab*-****-90ab-c-**********b
Command	string	The type of command executed on the current session.	Sleep
Status	string	The state of the session.	ACTIVE
SqlId	string	The ID of the SQL statement.	8D6E84**0B8FB1823D199E2CA1**
TraceId	string	The ID of the trace.	3c6e**-cb-11-a5-4201ac1****f
PlanId	string	The ID of the plan.	af621fe01e064743bd37e7c9a41aa139
SessionStatistics	object	The session statistics.
UserStatistics	array<object>	The user statistics.
	object	The return result of the request.
MetricValue	string	The value of the user metric.	admin
ActiveCount	long	The number of active sessions.	5
TotalCount	long	The total number of sessions.	15
Type	string	The type of the user.	user
SourceStatistics	array<object>	The data source statistics.
	object	The return result of the request.
MetricValue	string	The value of the data source metric.	127...*
ActiveCount	long	The number of active sessions.	2
TotalCount	long	The total number of sessions.	12
Type	string	The type of the data source.	client
DataBaseStatistics	array<object>	The database statistics.
	object	The return result of the request.
MetricValue	string	The value of the database metric.	test_database
ActiveCount	long	The number of active sessions.	1
TotalCount	long	The total number of sessions.	9
Type	string	The type of the database statistics.	database
ObVersion	string	The version of OceanBase Database.	4.2.1.0

Examples

Sample success responses

JSONformat

{
  "RequestId": "EE205C00-30E4-****-****-87E3A8A2AA0C",
  "Data": [
    {
      "TotalSessionCount": 500,
      "ActiveSessionCount": 25,
      "IdleSessionCount": 8,
      "AllProcessList": [
        {
          "SqlText": "SELECT * FROM table_name;",
          "TenantId": "t33h8y08k****",
          "Database": "database1",
          "User": "test1",
          "ExecuteTime": 18.23,
          "CpuTime": 257.943,
          "ServerIp": "127.*.*.*",
          "ClientIp": "127.*.*.*",
          "SessionId": 0,
          "ProxySessId": "ab***-********-90ab-c***-***********b",
          "Command": "Sleep",
          "Status": "ACTIVE",
          "SqlId": "8D6E84****0B8FB1823D199E2CA1****",
          "TraceId": "\n3c6e****-cb**-11**-a5**-4201ac1****f",
          "PlanId": "af621fe01e064743bd37e7c9a41aa139"
        }
      ],
      "SessionStatistics": {
        "UserStatistics": [
          {
            "MetricValue": "admin",
            "ActiveCount": 5,
            "TotalCount": 15,
            "Type": "user"
          }
        ],
        "SourceStatistics": [
          {
            "MetricValue": "127.*.*.*",
            "ActiveCount": 2,
            "TotalCount": 12,
            "Type": "client"
          }
        ],
        "DataBaseStatistics": [
          {
            "MetricValue": "test_database",
            "ActiveCount": 1,
            "TotalCount": 9,
            "Type": "database"
          }
        ]
      },
      "ObVersion": "4.2.1.0"
    }
  ]
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2024-05-27	The response structure of the API has changed	View Change Details