すべてのプロダクト
Search

このプロダクト

    Database Autonomy Service:GetMySQLAllSessionAsync

    ドキュメントセンター

    Database Autonomy Service:GetMySQLAllSessionAsync

    最終更新日:Mar 13, 2026

    インスタンスのセッションを非同期で照会し、ディメンションごとにセッション統計情報を収集します。

    操作説明

    説明

    GetMySQLAllSessionAsync は非同期操作です。リクエストを送信した後、システムは完全な結果を返さず、代わりにリクエスト ID を返します。このリクエスト ID を使用して再度リクエストを送信し、応答内の isFinish フィールドの値が true になるまで繰り返す必要があります。その時点で完全な結果が返されます。つまり、完全なデータを取得するには、本操作を少なくとも 2 回呼び出す必要があります。

    • 本操作は、ApsaraDB RDS for MySQL インスタンス、PolarDB for MySQL クラスター、および PolarDB-X 2.0 インスタンスのみで利用可能です。

    • Alibaba Cloud SDK または Database Autonomy Service (DAS) SDK を使用して本操作を呼び出す場合、最新バージョンの SDK を使用することを推奨します。

    • DAS の操作を SDK から呼び出す場合、リージョン ID を cn-shanghai に設定する必要があります。

    今すぐお試しください

    この 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 ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    hdm:GetMySQLAllSessionAsync

    get

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    InstanceId

    string

    必須

    インスタンス ID。

    説明

    ApsaraDB RDS for MySQL、PolarDB for MySQL、および PolarDB-X 2.0 インスタンスのみがサポートされています。

    rm-2ze8g2am97624****

    NodeId

    string

    任意

    ノード ID。

    説明

    PolarDB for MySQL クラスターでは、本パラメーターを指定する必要があります。ノード ID を指定しない場合、デフォルトでプライマリノードのセッションデータが返されます。

    pi-wz954ryd8f893****
    ResultId

    string

    任意

    非同期リクエスト ID。

    説明

    GetMySQLAllSessionAsync は非同期操作です。リクエストを送信した後、システムは完全な結果を返さず、代わりに リクエスト ID を返します。この リクエスト ID を使用して再度リクエストを送信し、応答内の isFinish フィールドの値が true になるまで繰り返す必要があります。その時点で完全な結果が返されます。つまり、完全なデータを取得するには、本操作を少なくとも 2 回呼び出す必要があります。

    async__507044db6c4eadfa2dab9b084e80****

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    Code

    integer

    返された HTTP ステータスコード。

    200
    Message

    string

    返されたメッセージ。

    説明

    リクエストが成功した場合は Successful が返され、失敗した場合はエラーコードなどのエラーメッセージが返されます。

    Successful
    Data

    object

    返されるデータ。

    Fail

    boolean

    非同期リクエストが失敗したかどうかを示します。有効な値：

    • true

    • false

    false
    SessionData

    object

    セッションデータ。

    TotalSessionCount

    integer

    セッションの合計数。

    988
    ActiveSessionCount

    integer

    アクティブセッションの合計数。

    10
    MaxActiveTime

    integer

    アクティブセッションの最大実行時間。単位：秒。

    6
    SessionList

    array<object>

    セッション一覧。

    object

    SessionId

    integer

    セッション ID。

    14521783
    User

    string

    データベースアカウントのユーザー名。

    testUser
    Client

    string

    クライアントの IP アドレス。

    47.100.XX.XX
    DbName

    string

    データベース名。

    dbTest
    Command

    string

    セッション内で実行されたコマンドの種類。

    Query
    Time

    integer

    セッションの実行時間。単位：秒。

    6
    State

    string

    セッションの状態。

    starting
    SqlText

    string

    セッション内で実行された SQL ステートメント。

    INSERT INTO ...
    UserClientAlias

    string

    クライアントの IP アドレスのエイリアス。

    master-shanghai
    TrxId

    string

    セッションが属するトランザクションの ID。

    754300775132
    TrxDuration

    integer

    トランザクションの持続時間。単位：秒。

    6
    SqlTemplateId

    string

    SQL テンプレート ID。

    説明

    本パラメーターは、PolarDB-X 2.0 インスタンスを使用する場合にのみ返されます。

    a7cac1a9
    UserStats

    array<object>

    データベースアカウントごとに集計されたセッション情報。

    object

    Key

    string

    データベースアカウント。

    testUser
    TotalCount

    integer

    アカウント内のセッションの合計数。

    2
    ActiveCount

    integer

    アカウント内のアクティブセッション数。

    説明

    セッション内で実行されたコマンドの種類が Query または Execute であり、トランザクション内のセッションが終了していない場合、そのセッションはアクティブとみなされます。

    1
    ThreadIdList

    array

    アカウント内のセッション ID 一覧。

    integer

    セッション ID。

    [14525727,14526269]
    UserList

    array

    セッションが属するデータベースアカウント一覧。

    string

    データベースアカウント。

    ['testUser']
    ClientStats

    array<object>

    クライアント IP アドレスごとに集計されたセッション情報。

    object

    Key

    string

    クライアントの IP アドレス。

    47.100.XX.XX
    TotalCount

    integer

    クライアント IP アドレスに属するセッションの合計数。

    2
    ActiveCount

    integer

    クライアント IP アドレスに属するアクティブセッション数。

    説明

    セッション内で実行されたコマンドの種類が Query または Execute であり、トランザクション内のセッションが終了していない場合、そのセッションはアクティブとみなされます。

    1
    ThreadIdList

    array

    クライアント IP アドレスに属するセッション ID 一覧。

    integer

    セッション ID。

    [14526018,14525956]
    UserList

    array

    セッションが属するデータベースアカウント一覧。

    string

    データベースアカウント。

    ['testUser']
    DbStats

    array<object>

    データベースごとに集計されたセッション情報。

    object

    Key

    string

    データベース名。

    dbTest
    TotalCount

    integer

    データベースのセッション合計数。

    2
    ActiveCount

    integer

    データベースのアクティブセッション数。

    説明

    セッション内で実行されたコマンドの種類が Query または Execute であり、トランザクション内のセッションが終了していない場合、そのセッションはアクティブとみなされます。

    1
    ThreadIdList

    array

    データベースのセッション ID 一覧。

    integer

    セッション ID。

    [14525727,14526269]
    UserList

    array

    セッションが属するデータベースアカウント一覧。

    string

    データベースアカウント。

    ['testUser']
    TimeStamp

    integer

    セッションが照会された時刻。これは、1970 年 1 月 1 日 00:00:00 UTC からの経過ミリ秒数を表す UNIX タイムスタンプです。

    1659581514000020
    ResultId

    string

    非同期リクエスト ID。

    async__507044db6c4eadfa2dab9b084e80****
    IsFinish

    boolean

    非同期リクエストが完了したかどうかを示します。有効な値：

    • true

    • false

    true
    State

    string

    非同期リクエストの状態。有効な値：

    • RUNNING

    • SUCCESS

    • FAIL

    SUCCESS
    Complete

    boolean

    非同期リクエストが完了したかどうかを示します。有効な値：

    • true

    • false

    true
    Timestamp

    integer

    非同期リクエストが送信された時刻。これは、1970 年 1 月 1 日 00:00:00 UTC からの経過ミリ秒数を表す UNIX タイムスタンプです。

    1660100753556
    RequestId

    string

    リクエスト ID。

    B6D17591-B48B-4D31-9CD6-9B9796B2****
    Success

    boolean

    リクエストが成功したかどうかを示します。有効な値：

    • true

    • false

    true

    例

    成功レスポンス

    JSONJSON

    {
  "Code": 200,
  "Message": "Successful",
  "Data": {
    "Fail": false,
    "SessionData": {
      "TotalSessionCount": 988,
      "ActiveSessionCount": 10,
      "MaxActiveTime": 6,
      "SessionList": [
        {
          "SessionId": 14521783,
          "User": "testUser",
          "Client": "47.100.XX.XX",
          "DbName": "dbTest",
          "Command": "Query",
          "Time": 6,
          "State": "starting",
          "SqlText": "INSERT INTO ...",
          "UserClientAlias": "master-shanghai",
          "TrxId": "754300775132",
          "TrxDuration": 6,
          "SqlTemplateId": "a7cac1a9"
        }
      ],
      "UserStats": [
        {
          "Key": "testUser",
          "TotalCount": 2,
          "ActiveCount": 1,
          "ThreadIdList": [
            0
          ],
          "UserList": [
            "['testUser']"
          ]
        }
      ],
      "ClientStats": [
        {
          "Key": "47.100.XX.XX",
          "TotalCount": 2,
          "ActiveCount": 1,
          "ThreadIdList": [
            0
          ],
          "UserList": [
            "['testUser']"
          ]
        }
      ],
      "DbStats": [
        {
          "Key": "dbTest",
          "TotalCount": 2,
          "ActiveCount": 1,
          "ThreadIdList": [
            0
          ],
          "UserList": [
            "['testUser']"
          ]
        }
      ],
      "TimeStamp": 1659581514000020
    },
    "ResultId": "async__507044db6c4eadfa2dab9b084e80****",
    "IsFinish": true,
    "State": "SUCCESS",
    "Complete": true,
    "Timestamp": 1660100753556
  },
  "RequestId": "B6D17591-B48B-4D31-9CD6-9B9796B2****",
  "Success": true
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    400 InvalidParams The request parameters are invalid.
    403 NoPermission You are not authorized to do this action.

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

    変更履歴

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