幫助中心
首頁 ApsaraDB for OceanBase (Deprecated) 開發參考 API參考 API目錄 會話串連 DescribeProcessStatsComposition - 查詢會話資訊

DescribeProcessStatsComposition - 查詢會話資訊

更新時間：
Copy as MD

該介面用於查詢會話資訊。

調試

您可以在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

返回參數

名稱

類型

描述

樣本值

object

請求的返回結果。

RequestId

string

請求 ID。

EE205C00-30E4-****-****-87E3A8A2AA0C
Data

object

返回結果。

TotalSessionCount

integer

總會話數量。

100
ActiveSessionCount

integer

活躍會話數。

60
IdleSessionCount

integer

SLEEP 狀態會話數量。

30
AllProcessList

array<object>

所有會話詳細資料。

array<object>

SqlText

string

SQL 文本。

select * from c1 where id = 100;
TenantId

string

租戶 ID。

t********
Database

string

資料庫名稱。

c1
User

string

該會話所屬的使用者。

test_user
ExecuteTime

integer

根據是否執行命令：

  • 如果是在接收請求後且在返回用戶端之前，表示從接收請求到目前時間的間隔

  • 如果是非接受請求情況下的狀態, 表示目前狀態的期間

單位為秒。

5
CpuTime

integer

當前命令執行 CPU 使用時間，單位：s。

說明

該欄位從 V3.2.4 BP5 版本開始引入

1
ServerIp

string

伺服器 IP 位址。

xx.xx.xx.xx
ClientIp

string

用戶端 IP。

xx.xx.xx.xx
SessionId

integer

會話 ID。

322441****
ProxySessId

string

如果當前用戶端是 ODP，則本列展示 ODP 的 Session ID。

7521015416********
Command

string

該會話正在執行的命令。

Query
Status

string

該會話當前的狀態。

ACTIVE
SqlId

string

SQL ID。

45CCBDC7DEBDCDAXXXXAFC********
TraceId

string

Trace ID。

YB420XXX128-00062XXXX8313XXX1-X-X
PlanId

integer

執行計畫 ID。

1898
DynamicSql

boolean

是否為動態 SQL。

false
ProcessSqlLists

array<object>

子 SQL 列表

array<object>

SqlText

string

SQL 文本。

select * from c1 where id = 100;
TenantId

string

租戶 ID。

t********
Database

string

資料庫名稱。

c2
User

string

該會話所屬的使用者。

test_user
ExecuteTime

integer

根據是否執行命令：

  • 如果是在接收請求後且在返回用戶端之前，表示從接收請求到目前時間的間隔

  • 如果是非接受請求情況下的狀態, 表示目前狀態的期間

單位為秒。

5
CpuTime

integer

當前命令執行 CPU 使用時間，單位：s。

說明

該欄位從 V3.2.4 BP5 版本開始引入

1
ServerIp

string

伺服器 IP 位址。

xx.xx.xx.xx
ClientIp

string

用戶端 IP。

xx.xx.xx.xx
SessionId

integer

會話 ID。

322441****
ProxySessId

string

如果當前用戶端是 ODP，則本列展示 ODP 的 Session ID。

7521015416********
Command

string

該會話正在執行的命令。

Query
Status

string

該會話當前的狀態。

ACTIVE
SqlId

string

SQL ID。

45CCBDC7DEBDCDAXXXXAFC********
TraceId

string

Trace ID。

YB420XXX128-00062XXXX8313XXX1-X-X
PlanId

integer

執行計畫 ID。

1898
DynamicSql

boolean

是否為動態 SQL。

false
ProcessSqlList

array<object>

子 SQL 列表

object

SqlText

string

SQL 文本。

select * from c1 where id = 100;
TenantId

string

租戶 ID。

t********
Database

string

資料庫名稱。

c3
User

string

該會話所屬的使用者。

test_user
ExecuteTime

integer

根據是否執行命令：

  • 如果是在接收請求後且在返回用戶端之前，表示從接收請求到目前時間的間隔

  • 如果是非接受請求情況下的狀態, 表示目前狀態的期間

單位為秒。

5
CpuTime

integer

當前命令執行 CPU 使用時間，單位：s。

說明

該欄位從 V3.2.4 BP5 版本開始引入

1
ServerIp

string

伺服器 IP 位址。

xx.xx.xx.xx
ClientIp

string

用戶端 IP。

xx.xx.xx.xx
SessionId

integer

會話 ID。

322441****
ProxySessId

string

如果當前用戶端是 ODP，則本列展示 ODP 的 Session ID。

7521015416********
Command

string

該會話正在執行的命令。

Query
Status

string

該會話當前的狀態。

ACTIVE
SqlId

string

SQL ID。

45CCBDC7DEBDCDAXXXXAFC********

TraceId

string

Trace ID。

YB420XXX128-00062XXXX8313XXX1-X-X
PlanId

integer

執行計畫 ID。

1898
DynamicSql

boolean

是否為動態 SQL。

false
ServerSn

string

節點 ID。

i-bp1*****sw64dhb*****
SessionStatistics

object

按照不同來源的會話統計。

UserStatistics

array<object>

按照使用者維度會話統計。

object

MetricValue

string

使用者名稱。

test_user
ActiveCount

integer

活躍會話數量。

25
TotalCount

integer

總數量。

30
Type

string

user。

user
SourceStatistics

array<object>

按照 Client 維度會話統計。

object

MetricValue

string

使用者用戶端 IP。

xx.xx.xx.xx
ActiveCount

integer

活躍會話數量。

25
TotalCount

integer

總數量。

30
Type

string

client。

client
DataBaseStatistics

array<object>

按照資料庫維度會話統計。

object

MetricValue

string

資料庫名。

test_database
ActiveCount

integer

活躍會話數量。

25
TotalCount

integer

總數量。

30
Type

string

database。

database
ObVersion

string

Ob 版本號碼

3.2.4

樣本

正常返回樣本

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"
  }
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。

上一篇：BatchKillProcessList - 批量關閉會話下一篇：KillProcessList - 關閉指定的會話