DescribeProcessList - ApsaraDB for ClickHouse - Alibaba Cloud Documentation Center

Queries the details of queries that are being executed in an ApsaraDB for ClickHouse cluster.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
clickhouse:DescribeProcessList	get	DBCluster acs:clickhouse:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}	none	none

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID. You can call the DescribeRegions operation to query the most recent region list.	cn-hangzhou
DBClusterId	string	Yes	The cluster ID. You can call the DescribeDBClusters operation to query information about all the clusters that are deployed in a specific region. The information includes the cluster IDs.	cc-bp1190tj036am****
QueryDurationMs	integer	Yes	The minimum query duration. The minimum value is 1000, and the default value is 1000. Unit: milliseconds. Queries that last longer than this duration are returned in response parameters.	500
InitialUser	string	No	The account that is used to log on to the database.	user
Keyword	string	No	The keyword that is used to query.	join
Order	string	No	Sorting by the specified column name. Valid values: elapsed: the cumulative execution time written_rows: the number of written rows read_rows: the number of read rows memory_usage: the memory usage	elapsed
PageSize	integer	No	The number of entries per page. Valid values: 30 (default) 50 100	30
PageNumber	integer	No	The page number. Pages start from page 1. Default value: 1.	1
InitialQueryId	string	No	The ID of the query statement.	6c69d508-f05f-4c74-857c-d982b7e7e79f

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	FD61BB0D-788A-5185-A8E3-1B90BA8F6F04
ProcessList	object	The queries.
TableSchema	array<object>	Details of the columns.
ResultSet	object
Type	string	The column type.	String
Name	string	The column name.	InitialUser
Data	array<object>	The details of the query.
ResultSet	object
QueryStartTime	string	The beginning of the time range to query. The value is in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in Coordinated Universal Time (UTC).	2021-02-02T09:14:48Z
Query	string	The SQL statement that is executed in the query.	select * from test order by score limit 1;
InitialAddress	string	The IP address of the client that initiates 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 execution duration of the query. Unit: milliseconds.	2000
Rows	string	The number of rows returned for the query.	1145700
RowsBeforeLimitAtLeast	string	The number of entries returned per page.	1
Statistics	object	The statistics of the results.
RowsRead	integer	The number of scanned rows.	1000000
ElapsedTime	float	The average response time.	4156
BytesRead	integer	The size of the data that was scanned. Unit: bytes.	9141300000

Examples

Sample success responses

JSONformat

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

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2024-09-25	API Description Update. The Error code has changed	View Change Details