DescribeProcessList - ApsaraDB for ClickHouse - Alibaba Cloud Documentation Center

Call the DescribeProcessList operation to retrieve running queries on an ApsaraDB for ClickHouse Community-Compatible cluster.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

clickhouse:DescribeProcessList

get

*DBCluster

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

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID. You can call the DescribeRegions operation to find the region ID.	cn-hangzhou
DBClusterId	string	Yes	The cluster ID. You can call the DescribeDBClusters operation to find information about all clusters in the destination region, including the cluster ID.	cc-bp1190tj036am****
QueryDurationMs	integer	No	The shortest query duration. The minimum value is 1000. The default value is 1000. The unit is milliseconds. The response returns queries that run longer than this duration.	500
InitialUser	string	No	The database account.	user
Keyword	string	No	The keyword for the query.	join
Order	string	No	The column to use for sorting. Valid values: elapsed: The total running time. written_rows: The number of rows written. read_rows: The number of rows read. memory_usage: The amount of memory used.	elapsed
PageSize	integer	No	The number of entries to return on each page. Valid values: 30 (Default) 50 100	30
PageNumber	integer	No	The page number. The value must be greater than 0 and cannot exceed the maximum value of the Integer data type. The default value is 1.	1
InitialQueryId	string	No	The ID of the query.	6c69d508-f05f-4c74-857c-d982b7e7e79f

Response elements

Element	Type	Description	Example
	object	The returned result.
RequestId	string	The request ID.	FD61BB0D-788A-5185-A8E3-1B90BA8F6F04
ProcessList	object	The list of tasks.
TableSchema	object
ResultSet	array<object>	The details of the columns.
	object
Type	string	The type of the column.	String
Name	string	The name of the column.	InitialUser
Data	object
ResultSet	array<object>	The details of the tasks.
	object
QueryStartTime	string	The time when the query started. The time is in the yyyy-MM-ddTHH:mm:ssZ format and is in UTC.	2021-02-02T09:14:48Z
Query	string	The query statement.	select * from test order by score limit 1;
InitialAddress	string	The IP address of the client that initiated the query.	::ffff:10.1.XX.XX
InitialQueryId	string	The query ID.	2dd144fd-4230-4249-b15c-e63f964fbb5a
InitialUser	string	The database account.	test
QueryDurationMs	string	The query duration in milliseconds.	2000
Rows	string	The number of rows returned for the query.	1145700
RowsBeforeLimitAtLeast	string	The page size in rows.	1
Statistics	object	The statistics of the query result.
RowsRead	integer	The number of rows scanned.	1000000
ElapsedTime	number	The elapsed time.	4156
BytesRead	integer	The size of the scanned data, in bytes.	9141300000

Examples

Success response

JSON format

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

Error codes

HTTP status code	Error code	Error message	Description
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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.