DescribeProcessList - ApsaraDB for ClickHouse - Alibaba Cloud Documentation Center

You can call the DescribeProcessList operation to view running queries.

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

list

*EnterpriseDBCluster

acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID.	cn-beijing
DBInstanceId	string	Yes	The cluster ID.	cc-xxxxx
QueryDurationMs	string	No	The execution duration of a slow query, in milliseconds (ms). The minimum value is 1000.	1000
InitialUser	string	No	The user who initiated the query.	testuser
Keyword	string	No	A keyword in the search statement.	SELECT
InitialQueryId	string	No	The query ID.	1
QueryOrder	integer	No	The column for sorting in descending order. 0: Sorts by query_duration_ms only. 1: Sorts by query_duration_ms and query_start_time. 2: Sorts by query_duration_ms, query_start_time, and user.	0
PageSize	integer	No	The number of records on each page.	30
PageNumber	integer	No	The page number.	1
ComputingGroupId	string	No

Response elements

Element	Type	Description	Example
	object	The returned parameters.
RequestId	string	The request ID.	xxx-xxx-xxx
Data	object	The returned result.
DBInstanceID	integer	The cluster ID.	cc-xxxx
DBInstanceName	string	The cluster name.	测试使用
TotalCount	integer	The total number of records.	1
ResultSet	array<object>	The result set.
	object
InitialQueryId	string	The query ID.	'79f7e40b-87e2-4ef4-b6df-21889a3a030e'
QueryStartTime	string	The start time of the query. The format is yyyy-MM-ddTHH:mm:ssZ in Coordinated Universal Time (UTC).	2023-07-23T10:13:23Z
InitialAddress	string	The query address.	0:0:0:0:0:ffff:1edd65ea
Query	string	The statement that is being queried.	select * from test
InitialUser	string	The user who initiated the query.	bany
QueryDurationMs	integer	The minimum query duration. The minimum value is 1000. Unit: milliseconds.	1000

Examples

Success response

JSON format

{
  "RequestId": "xxx-xxx-xxx",
  "Data": {
    "DBInstanceID": 0,
    "DBInstanceName": "测试使用",
    "TotalCount": 1,
    "ResultSet": [
      {
        "InitialQueryId": "'79f7e40b-87e2-4ef4-b6df-21889a3a030e'",
        "QueryStartTime": "2023-07-23T10:13:23Z",
        "InitialAddress": "0:0:0:0:0:ffff:1edd65ea",
        "Query": "select * from test",
        "InitialUser": "bany",
        "QueryDurationMs": 1000
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.