DescribeDiagnosisRecords - AnalyticDB for MySQL - Alibaba Cloud Documentation Center

Queries the diagnostic information about SQL statements that meet a condition 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.

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:DescribeDiagnosisRecords	Read	DBCluster acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}	none	none

Request parameters

Parameter	Type	Required	Description	Example
DBClusterId	string	Yes	The cluster ID. Note You can call the DescribeDBClusters operation to query the information about all AnalyticDB for MySQL clusters within a region, including cluster IDs.	am-bp1r053byu48p****
StartTime	string	Yes	The beginning of the time range to query. Specify a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC. Note Only data within the last 14 days can be queried.	1632931200000
EndTime	string	Yes	The end of the time range to query. Specify a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC. Note The end time must be later than the start time. The maximum time range that can be specified is 24 hours.	1633017540000
RegionId	string	Yes	The region ID of the cluster. Note You can call the DescribeRegions operation to query the most recent region list.	cn-hangzhou
QueryCondition	string	Yes	The query condition for SQL statements, which can contain the `Type`, `Value`, and `Min` or `Max` fields. Specify the condition 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 executed SQL statements. You can set `Value` to `running` to query SQL statements that are being executed. You can also set Value to `failed` to query SQL statements that failed to be executed. `{"Type":"cost","Min":"10","Max":"200"}`: queries SQL statements whose execution durations are in the range of 10 to 200 milliseconds. You can also customize the maximum and minimum execution durations.	{"Type":"status","Value":"finished"}
Keyword	string	No	The keyword for the query.	select
MinPeakMemory	long	No	The minimum peak memory of the SQL statements. Unit: bytes.	0
MaxPeakMemory	long	No	The maximum peak memory of the SQL statements. Unit: bytes.	89000000
MinScanSize	long	No	The minimum scan size of the SQL statements. Unit: bytes.	0
MaxScanSize	long	No	The maximum scan size of the SQL statements. Unit: bytes.	104428198
ResourceGroup	string	No	The resource group to which the SQL statements belong. Note You can call the DescribeDiagnosisDimensions operation to query the resource group, database name, username, and source IP address of the SQL statements to be queried.	user_default
UserName	string	No	The username that is used to execute the SQL statements. Note You can call the DescribeDiagnosisDimensions operation to query the resource group, database name, username, and source IP address of the SQL statements to be queried.	test_user
Database	string	No	The database on which the SQL statements are executed. Note You can call the DescribeDiagnosisDimensions operation to query the resource group, database name, username, and source IP address of the SQL statements to be queried.	adb_demo
ClientIp	string	No	The source IP address. Note You can call the DescribeDiagnosisDimensions operation to query the resource group, database name, username, and source IP address of the SQL statements to be queried.	59.82.xx.xx
Order	string	No	The order in which to sort the retrieved SQL statements by field. Specify this value in the JSON format. The value is an ordered array that uses the order of the input array and contains the `Field` and `Type` fields. Example: `[{"Field":"StartTime", "Type": "desc" }]`. Fields: `Field` specifies the field that is used to sort the retrieved SQL statements. Valid values: `StartTime`: the start time of the execution. `Status`: the execution state. `UserName`: the username. `Cost`: the execution duration. `PeakMemory`: the peak memory. `ScanSize`: the amount of data to be scanned. `Database`: the name of the database. `ClientIp`: the source IP address. `ResourceGroup`: the name of the resource group. `QueueTime`: the amount of time that is consumed for queuing. `OutputRows`: the number of output rows. `OutputDataSize`: the amount of output data. `ResourceCostRank`: the execution duration rank of operators that are used in the SQL statements. This field takes effect only when `QueryCondition` is set to `{"Type":"status","Value":"running"}`. `Type` specifies the sorting order. Valid values (case-insensitive): `Desc`: descending order. `Asc`: ascending order.	[{"Field":"StartTime", "Type": "desc" }]
PageNumber	integer	No	The page number. Pages start from page 1. Default value: 1.	1
PageSize	integer	No	The number of entries per page. Valid values: 30, 50, and 100. Default value: 30.	30
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
PatternId	string	No	The SQL pattern ID. Note You can call the DescribeSQLPatterns operation to query the information about all SQL patterns within an AnalyticDB for MySQL cluster in a time range, including SQL pattern IDs.	5575924945138******

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
PageNumber	integer	The page number.	1
PageSize	integer	The number of entries per page.	30
TotalCount	integer	The total number of entries returned.	1
Querys	object []	The queried SQL statements.
SQL	string	The SQL statement. Note For performance considerations, an SQL statement cannot exceed 5,120 characters in length. Otherwise, the SQL statement is truncated. You can call the DownloadDiagnosisRecords operation to download the diagnostic information about SQL statements that meet a condition in an AnalyticDB for MySQL cluster, including the complete SQL statements.	SELECT count(*)\nFROM nation
SQLTruncatedThreshold	long	The maximum length of the SQL statement. 5120 is returned. Unit: character. SQL statements that exceed this limit are truncated.	5120
Status	string	The state of the SQL statement. Valid values: running finished failed	finished
OutputDataSize	long	The amount of returned data. Unit: bytes.	9
Cost	long	The total execution duration. Unit: milliseconds. Note This value is the cumulative value of the `QueuedTime`, `TotalPlanningTime`, and `ExecutionTime` parameters.	10
OutputRows	long	The number of rows returned.	1
RcHost	string	The IP address and port number of the AnalyticDB for MySQL frontend node on which the SQL statement is executed.	10.0.xx.xx:3004
ScanSize	long	The amount of scanned data. Unit: bytes.	9
ProcessId	string	The query ID.	2021093000414401000000023503151******
StartTime	long	The beginning of the time range in which the SQL statement is executed. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.	1632933704000
SQLTruncated	boolean	Indicates whether the SQL statement is truncated. Valid values: true false	false
Database	string	The name of the database on which the SQL statement is executed.	adb_demo
ScanRows	long	The number of entries scanned.	1
ResourceCostRank	integer	The execution duration rank of operators that are used in the SQL statement. Note This field is returned only for SQL statements that have the `Status` parameter set to `running`.	1
ClientIp	string	The source IP address.	59.82.xx.xx
PeakMemory	long	The peak memory. Unit: bytes.	16648
QueueTime	long	The amount of time that is consumed for queuing. Unit: milliseconds.	0
ResourceGroup	string	The resource group to which the SQL statement belongs.	user_default
UserName	string	The username that is used to execute the SQL statement.	test_user
ExecutionTime	long	The execution duration. Unit: milliseconds.	6
TotalPlanningTime	long	The amount of time that is consumed to generate an execution plan. Unit: milliseconds.	4
EtlWriteRows	long	The number of rows written to the table by an extract, transform, and load (ETL) task.	0
TotalStages	integer	The total number of stages generated.	2
RequestId	string	The request ID.	109462AF-B5FA-3D5A-9377-B27E5B******

Examples

Sample success responses

JSONformat

{
  "PageNumber": 1,
  "PageSize": 30,
  "TotalCount": 1,
  "Querys": [
    {
      "SQL": "SELECT count(*)\\nFROM nation",
      "SQLTruncatedThreshold": 5120,
      "Status": "finished",
      "OutputDataSize": 9,
      "Cost": 10,
      "OutputRows": 1,
      "RcHost": "10.0.xx.xx:3004",
      "ScanSize": 9,
      "ProcessId": "2021093000414401000000023503151******",
      "StartTime": 1632933704000,
      "SQLTruncated": false,
      "Database": "adb_demo",
      "ScanRows": 1,
      "ResourceCostRank": 1,
      "ClientIp": "59.82.xx.xx",
      "PeakMemory": 16648,
      "QueueTime": 0,
      "ResourceGroup": "user_default",
      "UserName": "test_user",
      "ExecutionTime": 6,
      "TotalPlanningTime": 4,
      "EtlWriteRows": 0,
      "TotalStages": 2
    }
  ],
  "RequestId": "109462AF-B5FA-3D5A-9377-B27E5B******"
}