Queries the details of queries that are being executed in an AnalyticDB for MySQL cluster.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeProcessList

The operation that you want to perform. Set the value to DescribeProcessList.

DBClusterId String Yes am-bp11q28kvl688****

The ID of the cluster.

ShowFull Boolean No True

Specifies whether to show a complete SQL statement. Valid values:

  • True: shows a complete SQL statement.
  • False: shows only the first 100 characters of an SQL statement.
Note The default value is False.
RunningTime Integer No 5

The execution duration used to filter queries. Queries that take a longer time than the specified execution duration are displayed. Unit: seconds.

User String No test

The name of the user used to filter queries.

Keyword String No SELECT

The keyword in an SQL statement, which is used to filter queries. Set the value to SELECT.

Order String No [ { "Field":"Time","Type":"Desc" }, { "Field":"User", "Type":"Asc" }]

The order in which queries are sorted based on the specified fields. 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.
PageSize Integer No 30

The number of entries to return on each page. Default value: 30. Valid values:

  • 30
  • 50
  • 100
PageNumber Integer No 1

The number of the page to return. The value must be an integer that is greater than 0. Default value: 1.

Response parameters

Parameter Type Example Description
TotalCount String 1

The total number of entries returned.

PageSize String 30

The total number of pages returned.

RequestId String 1AD222E9-E606-4A42-BF6D-8A4442913CEF

The ID of the request.

PageNumber String 1

The page number of the returned page.

Items Array of Process

Details of the queries.

Process
StartTime String 2020-11-19T02:48:15Z

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.

Time Integer 11

The amount of time that has elapsed from the start time of the query. Unit: seconds.

ProcessId String 202011191048151921681492420315100****

The unique ID of the query. You must specify this parameter when you use the KILL PROCESS statement.

Host String 192.168.XX.XX:12308

The IP address from which the query was initiated.

DB String adb_demo

The name of the database.

Command String SELECT

The type of the statement. Only SELECT can be returned.

User String test

The username.

Id Integer 49104

The ID of the worker thread.

Info String select * from sbtest1,sbtest2,sbtest3,sbtest4

The SQL statement that is being executed. By default, the first 100 characters of the SQL statement are returned. If the ShowFull parameter is set to True, the complete SQL statement is returned.

Examples

Sample requests

http(s)://adb.aliyuncs.com/?Action=DescribeProcessList
&DBClusterId=am-bp11q28kvl688****
&ShowFull=True
&RunningTime=5
&User=test
&Keyword=SELECT
&Order=[ { "Field":"Time","Type":"Desc" },  { "Field":"User", "Type":"Asc" }]
&PageSize=30
&PageNumber=1
&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

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

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "TotalCount" : 1,
  "PageSize" : 30,
  "RequestId" : "1AD222E9-E606-4A42-BF6D-8A4442913CEF",
  "PageNumber" : 1,
  "Items" : {
    "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
404 InvalidDBCluster.NotFound The DBClusterId provided does not exist in our records. The error message returned because the specified DBClusterId parameter does not exist. Check whether the cluster ID is valid.

For a list of error codes, visit the API Error Center.