DescribeDiagnosisMonitorPerformance - AnalyticDB for MySQL

Queries the monitoring information about queries within a time range.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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
adb:DescribeDiagnosisMonitorPerformance	Read	DBCluster acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}	none	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. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.	1671684348000
EndTime	string	Yes	The end of the time range to query. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.	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, which can be a combination of the `Type` and `Value` fields or a combination of the Type, `Min`, and `Max` fields. Specify the conditions in the JSON format. `Type` specifies the query dimension. Valid values for Type: `maxCost`, `status`, and `cost`. `Value`, `Min`, or `Max` specifies the query range for the dimension. 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. You can set `Value` to `running` to query the SQL statements that are being executed. You can also 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. You can also specify custom values for the Min and Max fields.	{\"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 parameters

Parameter	Type	Description	Example
	object
PerformancesThreshold	integer	The threshold for the number of queries 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	object []	The monitoring information about queries displayed in Gantt charts.
Status	string	The status of the SQL statement. Valid values: running finished failed	running
ProcessId	string	The query ID. Note You can call the DescribeProcessList operation to query the IDs of queries that are being executed.	202210311015270330101470300315153****
StartTime	long	The execution start time of the SQL statement. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.	1669011260000
Cost	long	The total execution duration. Unit: milliseconds. Note This value is the cumulative value of the `QueuedTime`, `TotalPlanningTime`, and `ExecutionTime` parameters.	252
ScanRows	long	The number of rows scanned.	2345
PeakMemory	long	The peak memory of the query. Unit: bytes.	123
RcHost	string	The IP address of the AnalyticDB for MySQL frontend node on which the SQL statement is executed.	192.168.XX.XX
ScanSize	long	The amount of scanned data. Unit: bytes.	123
UserName	string	The database account that is used to submit the query.	rpt

Examples

Sample success responses

JSONformat

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

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