すべてのプロダクト
Search

このプロダクト

    ApsaraDB for ClickHouse:DescribeProcessList

    ドキュメントセンター

    ApsaraDB for ClickHouse:DescribeProcessList

    最終更新日:Dec 05, 2025

    DescribeProcessList 操作を呼び出して、ApsaraDB for ClickHouse Community-Compatible クラスターで実行中のクエリを取得します。

    今すぐお試しください

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

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    clickhouse:DescribeProcessList

    get

    *DBCluster

    acs:clickhouse:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    RegionId

    string

    任意

    リージョン ID。DescribeRegions 操作を呼び出して、リージョン ID を確認できます。

    cn-hangzhou
    DBClusterId

    string

    必須

    クラスター ID。DescribeDBClusters 操作を呼び出して、ターゲットリージョン内のすべてのクラスター (クラスター ID を含む) に関する情報を確認できます。

    cc-bp1190tj036am****
    QueryDurationMs

    integer

    任意

    最短クエリ実行時間。最小値は 1000 です。デフォルト値は 1000 です。単位はミリ秒です。この実行時間より長く実行されているクエリがレスポンスで返されます。

    500
    InitialUser

    string

    任意

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

    user
    Keyword

    string

    任意

    クエリのキーワード。

    join
    Order

    string

    任意

    ソートに使用する列。有効な値：

    • elapsed：合計実行時間。

    • written_rows：書き込まれた行数。

    • read_rows：読み取られた行数。

    • memory_usage：使用されたメモリ量。

    elapsed
    PageSize

    integer

    任意

    各ページで返すエントリ数。有効な値：

    • 30 (デフォルト)

    • 50

    • 100

    30
    PageNumber

    integer

    任意

    ページ番号。値は 0 より大きく、Integer データ型の最大値を超えることはできません。デフォルト値は 1 です。

    1
    InitialQueryId

    string

    任意

    クエリの ID。

    6c69d508-f05f-4c74-857c-d982b7e7e79f

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    返された結果。

    RequestId

    string

    リクエスト ID。

    FD61BB0D-788A-5185-A8E3-1B90BA8F6F04
    ProcessList

    object

    タスクのリスト。

    TableSchema

    object

    ResultSet

    array<object>

    列の詳細。

    object

    Type

    string

    列の型。

    String
    Name

    string

    列の名前。

    InitialUser
    Data

    object

    ResultSet

    array<object>

    タスクの詳細。

    object

    QueryStartTime

    string

    クエリが開始された時間。時間は yyyy-MM-ddTHH:mm:ssZ 形式の UTC です。

    2021-02-02T09:14:48Z
    Query

    string

    クエリ文。

    select * from test order by score limit 1;
    InitialAddress

    string

    クエリを開始したクライアントの IP アドレス。

    ::ffff:10.1.XX.XX
    InitialQueryId

    string

    クエリ ID。

    2dd144fd-4230-4249-b15c-e63f964fbb5a
    InitialUser

    string

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

    test
    QueryDurationMs

    string

    クエリの実行時間 (ミリ秒)。

    2000
    Rows

    string

    クエリに対して返された行数。

    1145700
    RowsBeforeLimitAtLeast

    string

    ページサイズ (行単位)。

    1
    Statistics

    object

    クエリ結果の統計。

    RowsRead

    integer

    スキャンされた行数。

    1000000
    ElapsedTime

    number

    経過時間。

    4156
    BytesRead

    integer

    スキャンされたデータのサイズ (バイト単位)。

    9141300000

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "FD61BB0D-788A-5185-A8E3-1B90BA8F6F04",
  "ProcessList": {
    "TableSchema": {
      "ResultSet": [
        {
          "Type": "String",
          "Name": "InitialUser"
        }
      ]
    },
    "Data": {
      "ResultSet": [
        {
          "QueryStartTime": "2021-02-02T09:14:48Z",
          "Query": "select * from test order by score limit 1;",
          "InitialAddress": "::ffff:10.1.XX.XX",
          "InitialQueryId": "2dd144fd-4230-4249-b15c-e63f964fbb5a",
          "InitialUser": "test",
          "QueryDurationMs": "2000"
        }
      ]
    },
    "Rows": "1145700",
    "RowsBeforeLimitAtLeast": "1",
    "Statistics": {
      "RowsRead": 1000000,
      "ElapsedTime": 4156,
      "BytesRead": 9141300000
    }
  }
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    500 InternalError An error occurred while processing your request. An error occurred while processing your request.
    503 ServiceUnavailable An error occurred while processing your request. An error occurred while processing your request.

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

    変更履歴

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