すべてのプロダクト
Search

このプロダクト

    ApsaraDB for OceanBase (Deprecated):DescribeProcessStatsComposition

    ドキュメントセンター

    ApsaraDB for OceanBase (Deprecated):DescribeProcessStatsComposition

    最終更新日:May 26, 2026

    DescribeProcessStatsComposition

    今すぐお試しください

    この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

    テスト

    RAM 認証

    下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

    • アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。

    • API：アクションを具体的に実行するための API。

    • アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。

    • リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。

      • リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。

      • リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。

    • 条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。

    • 依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    oceanbase:DescribeProcessStatsComposition

    get

    *Instance

    acs:oceanbase:{#regionId}:{#accountId}:instance/{#InstanceId}

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    InstanceId

    string

    必須

    OceanBase クラスターの ID です。

    ob********
    UId

    string

    任意

    ユーザーアカウントの識別子 (UID) です。

    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

    任意

    データベースのユーザー名のリストです。JSON 配列形式の文字列で指定します。

    ["test_user"]
    Status

    string

    任意

    セッションのステータスです。

    ACTIVE
    MergeDynamicSql

    boolean

    任意

    戻り値で動的 SQL をマージするかどうかを指定します。

    説明


    出力で IN クエリの結果を集約するかどうかを指定します。

    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

    このパラメーターは、SQL 文の実行状況によって示す内容が異なります。

    • リクエストが受理されたものの、結果がまだクライアントに返されていない場合：リクエストの受理時刻から現在時刻までの経過時間 (秒) を示します。

    • リクエストが受理されていない場合：現在のステータスの継続時間 (秒) を示します。

    5
    CpuTime

    integer

    現在の SQL 文の実行にかかった CPU 時間 (秒)。

    説明

    このパラメーターは、バージョン 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

    クライアントのセッション ID です。OceanBase Database Proxy (ODP) 経由で接続している場合は、ODP のセッション ID を返します。

    7521015416********
    Command

    string

    セッションで実行中の SQL ステートメントのタイプ。

    Query
    Status

    string

    セッションのステータス。

    ACTIVE
    SqlId

    string

    SQL ステートメントの ID。

    45CCBDC7DEBDCDAXXXXAFC********
    TraceId

    string

    トレース ID。

    YB420XXX128-00062XXXX8313XXX1-X-X
    PlanId

    integer

    実行計画 ID。

    1898
    DynamicSql

    boolean

    SQL が動的 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 時間 (秒)。

    説明

    このパラメーターは、バージョン 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 のセッション ID を返します。

    7521015416********
    Command

    string

    セッションが実行しているコマンド。

    Query
    Status

    string

    セッションの現在のステータス。

    ACTIVE
    SqlId

    string

    SQL ID。

    45CCBDC7DEBDCDAXXXXAFC********
    TraceId

    string

    トレース ID。

    YB420XXX128-00062XXXX8313XXX1-X-X
    PlanId

    integer

    実行計画 ID。

    1898
    DynamicSql

    boolean

    SQL が動的 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 時間 (秒)。

    説明

    このパラメーターは、バージョン 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 のセッション ID を返します。

    7521015416********
    Command

    string

    セッションが実行しているコマンド。

    Query
    Status

    string

    セッションの現在のステータス。

    ACTIVE
    SqlId

    string

    SQL ID。

    45CCBDC7DEBDCDAXXXXAFC********

    TraceId

    string

    トレース ID。

    YB420XXX128-00062XXXX8313XXX1-X-X
    PlanId

    integer

    実行計画 ID。

    1898
    DynamicSql

    boolean

    SQL が動的 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>

    クライアント別のセッションデータ。

    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

    OceanBase Database のバージョン。

    3.2.4

    例

    成功レスポンス

    JSONJSON

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

    エラーコード

    完全なリストについては、「エラーコード」をご参照ください。

    変更履歴

    完全なリストについては、「変更履歴」をご参照ください。