Use DescribeProcessList to query the list of executing queries - AnalyticDB - Alibaba Cloud - AnalyticDB

Queries the running queries on a 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

adb:DescribeProcessList

get

DBCluster

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

None

Request parameters

Parameter	Type	Required	Description	Example
DBClusterId	string	Yes	The ID of the cluster.	am-bp11q28kvl688****
ShowFull	boolean	No	Specifies whether to return the complete SQL statement. Valid values: True: returns the complete SQL statement. False: returns only the first 100 characters of the SQL statement. Note The default value is False.	True
RunningTime	integer	No	The minimum execution duration used to filter queries. Only queries that run longer than the specified duration are returned. Unit: seconds.	5
User	string	No	The username to filter queries by.	test
Keyword	string	No	The keyword in the SQL statement to filter queries by. Set the value to SELECT.	SELECT
Order	string	No	The sort order for queries. Specify this parameter as an ordered JSON array in the `[{"Field":"Time","Type":"Desc" },{ "Field":"User", "Type":"Asc" }]` format. Field specifies the field used to sort queries. Valid values: Time, User, Host, and DB. Type specifies the sorting sequence. Valid values: Desc and Asc.	[ { "Field":"Time","Type":"Desc" }, { "Field":"User", "Type":"Asc" }]
PageSize	integer	No	The number of entries per page. Valid values: 30 (default) 50 100	30
PageNumber	integer	No	The page number to return. The value must be an integer greater than 0. Default value: 1.	1

Response elements

Element	Type	Description	Example
	object
TotalCount	string	The total number of entries returned.	1
PageSize	string	The total number of pages returned.	30
RequestId	string	The ID of the request.	1AD222E9-E606-4A42-BF6D-8A4442913CEF
PageNumber	string	The page number of the returned page.	1
Items	object
Process	array<object>	Details of the queries.
	object
StartTime	string	The start time of the query. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2020-11-19T02:48:15Z
Time	integer	The elapsed time since the query started. Unit: seconds.	11
ProcessId	string	The unique ID of the query. Specify this ID when you use the KILL PROCESS statement.	202011191048151921681492420315100****
Host	string	The IP address from which the query was initiated.	192.168.XX.XX:12308
DB	string	The name of the database.	adb_demo
Command	string	The type of the statement. Only SELECT is returned.	SELECT
User	string	The username.	test
Id	integer	The ID of the worker thread.	49104
Info	string	The SQL statement being executed. By default, only the first 100 characters are returned. If ShowFull is set to True, the complete SQL statement is returned.	select * from sbtest1,sbtest2,sbtest3,sbtest4

Examples

Success response

JSON format

{
  "TotalCount": "1",
  "PageSize": "30",
  "RequestId": "1AD222E9-E606-4A42-BF6D-8A4442913CEF",
  "PageNumber": "1",
  "Items": {
    "Process": [
      {
        "StartTime": "2020-11-19T02:48:15Z",
        "Time": 11,
        "ProcessId": "202011191048151921681492420315100****",
        "Host": "192.168.XX.XX:12308",
        "DB": "adb_demo",
        "Command": "SELECT",
        "User": "test",
        "Id": 49104,
        "Info": "select * from sbtest1,sbtest2,sbtest3,sbtest4"
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	IncorrectModuleVersion	The specified module version does not support this operation.	The specified module version does not support this operation.
400	AnalyticDBKernelError	Calling AnalyticDB Kernel error
404	InvalidDBCluster.NotFound	The DBClusterId provided does not exist in our records.	The specified DBClusterId parameter does not exist. Make sure that the DBClusterId value is valid.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.