DownloadDiagnosisRecords - AnalyticDB - Alibaba Cloud Documentation Center

Downloads the diagnostic information about SQL statements that meet a query condition for an AnalyticDB for MySQL Data Lakehouse Edition (V3.0) cluster.

Operation description

For information about the endpoints of AnalyticDB for MySQL, see Endpoints .

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

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:
- For mandatory resource types, indicate with a prefix of * .
- 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:DownloadDiagnosisRecords	create	*DBClusterLakeVersion `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 Lakehouse Edition (V3.0) cluster. Note You can call the DescribeDBClusters operation to query the IDs of all AnalyticDB for MySQL Data Lakehouse Edition (V3.0) clusters within a region.	amv-bp1q8bu9a****
StartTime	string	Yes	The beginning of the time range to query. Set the time to a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC. Note You can query data only within the last 14 days.	1662364330000
EndTime	string	Yes	The end of the time range to query. Set the time to 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.	1662450730000
RegionId	string	Yes	The region ID of the cluster.	cn-hangzhou
QueryCondition	string	Yes	The query condition for SQL statements, which can contain the `Type`, `Value`, `Min`, and `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 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":"status","Value":"finished"}
Keyword	string	No	The query keyword of the SQL statements.	select
MinPeakMemory	long	No	The minimum peak memory of the SQL statements. Unit: bytes.	88000000
MaxPeakMemory	long	No	The maximum peak memory of the SQL statements. Unit: bytes.	88000000
MinScanSize	long	No	The minimum scan size of the SQL statements. Unit: bytes.	1073741824
MaxScanSize	long	No	The maximum scan size of the SQL statements. Unit: bytes.	64424509440
ResourceGroup	string	No	The resource group to which the SQL statements belong. Note You can call the DescribeDiagnosisDimensions operation to query the resource groups, database names, usernames, and source IP addresses of the SQL statements that meet a query condition.	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 groups, database names, usernames, and source IP addresses of the SQL statements that meet a query condition.	test_user
Database	string	No	The name of the database on which the SQL statements are executed. Note You can call the DescribeDiagnosisDimensions operation to query the resource groups, database names, usernames, and source IP addresses of the SQL statements that meet a query condition.	adb_demo
ClientIp	string	No	The source IP address. Note You can call the DescribeDiagnosisDimensions operation to query the resource groups, database names, usernames, and source IP addresses of the SQL statements that meet a query condition.	106.11.XX.XX
Lang	string	No	The language. Valid values: zh: simplified Chinese. en: English. ja: Japanese. zh-tw: traditional Chinese.	zh

Response parameters

Parameter	Type	Description	Example
	object
DownloadId	integer	The download ID.	25494
RequestId	string	The request ID.	845774AC-5D43-53A2-AAB8-C73828E68508

Examples

Sample success responses

JSONformat

{
  "DownloadId": 25494,
  "RequestId": "845774AC-5D43-53A2-AAB8-C73828E68508"
}

Error codes

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

Change history

Change time	Summary of changes	Operation
2023-09-13	The internal configuration of the API is changed, but the call is not affected	View Change Details