Use DescribeDiagnosisMonitorPerformance to diagnose query performance - AnalyticDB - Alibaba Cloud - AnalyticDB

Retrieves query execution monitoring data for a specified time range.

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:DescribeDiagnosisMonitorPerformance

get

DBCluster

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

None

Request parameters

Parameter	Type	Required	Description	Example
DBClusterId	string	Yes	The ID of the AnalyticDB for MySQL Data Warehouse Edition (V3.0) cluster. Note You can call the DescribeDBClusters operation to query the cluster IDs of all AnalyticDB for MySQL Data Warehouse Edition (V3.0) clusters within a region.	am-bp108q1py5r78****
StartTime	string	Yes	The beginning of the time range to query. Specify a UNIX timestamp in milliseconds.	1671684348000
EndTime	string	Yes	The end of the time range to query. Specify a UNIX timestamp in milliseconds.	1671687948000
RegionId	string	Yes	The region ID of the cluster. Note You can call the DescribeRegions operation to query the most recent region list.	cn-beijing
QueryCondition	string	Yes	The query conditions for SQL statements in JSON format. Specify a combination of `Type` and `Value`, or `Type`, `Min`, and `Max`. Valid values for `Type`: `maxCost`, `status`, and `cost`. Valid values: `{"Type":"maxCost","Value":"100"}`: queries the top 100 most time-consuming SQL statements. Set `Value` to 100. `{"Type":"status","Value":"finished"}`: queries the executed SQL statements, including successful and failed SQL statements. Set `Value` to `running` to query the SQL statements that are being executed, or set Value to `failed` to query the SQL statements that failed to be executed. `{"Type":"cost","Min":"10","Max":"200"}`: queries the SQL statements whose execution duration is in the range of 10 to 200 milliseconds. Customize the values for the Min and Max fields as needed.	{\"Type\":\"maxCost\",\"Value\":\"100\"}
Lang	string	No	The language of file titles and error messages. Valid values: zh (default): simplified Chinese. en: English. ja: Japanese. zh-tw: traditional Chinese.	zh

Response elements

Element	Type	Description	Example
	object
PerformancesThreshold	integer	The maximum number of queries that can be displayed in a Gantt chart. Default value: 10000. Note Up to 10,000 queries can be displayed in a Gantt chart even if more queries exist.	10000
PerformancesTruncated	boolean	Indicates whether all queries are returned. Valid values: true false	false
RequestId	string	The request ID.	0F1AC5FD-16E9-5399-B81F-5AC434B1D9F8
Performances	array<object>	The monitoring information about queries displayed in Gantt charts.
	object
Status	string	The status of the SQL statement. Valid values: running finished failed	running
ProcessId	string	The query ID.	202210311015270330101470300315153****
StartTime	integer	The execution start time of the SQL statement. The value is a UNIX timestamp in milliseconds.	1669011260000
Cost	integer	The total execution duration. Unit: milliseconds. Note This value is the sum of the `QueuedTime`, `TotalPlanningTime`, and `ExecutionTime` values.	252
ScanRows	integer	The number of rows scanned.	2345
PeakMemory	integer	The peak memory usage of the query. Unit: bytes.	123
RcHost	string	The IP address of the AnalyticDB for MySQL frontend node that executed the SQL statement.	192.168.XX.XX
ScanSize	integer	The amount of scanned data. Unit: bytes.	123
UserName	string	The database account used to submit the query.	rpt

Examples

Success response

JSON format

{
  "PerformancesThreshold": 10000,
  "PerformancesTruncated": false,
  "RequestId": "0F1AC5FD-16E9-5399-B81F-5AC434B1D9F8",
  "Performances": [
    {
      "Status": "running",
      "ProcessId": "202210311015270330101470300315153****",
      "StartTime": 1669011260000,
      "Cost": 252,
      "ScanRows": 2345,
      "PeakMemory": 123,
      "RcHost": "192.168.XX.XX",
      "ScanSize": 123,
      "UserName": "rpt"
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.