DescribeDiagnosisDimensions - AnalyticDB - Alibaba Cloud Documentation Center

Queries the deduplicated statistics of SQL statements that meet a condition of the resource group, database, username, and source IP address in an AnalyticDB for MySQL cluster.

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:DescribeDiagnosisDimensions	get	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 IDs of all AnalyticDB for MySQL Data Warehouse Edition (V3.0) clusters within a region.	am-bt6u59zcmd945****
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. If you call this operation to query data that is earlier than 14 days, an empty string is returned.	1625220210000
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.	1625220213000
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 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, including successful and failed 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	The response parameters.
ClientIps	array	The source IP addresses.
ClientIps	string	The source IP address.	106.11.xx.xx
ResourceGroups	array	The resource groups.
ResourceGroups	string	The name of the resource group.	user_default
UserNames	array	The usernames.
UserNames	string	The username.	test_user
Databases	array	The databases.
Databases	string	The name of the database.	tpch_1g
RequestId	string	The request ID.	E0B56BCD-1BED-30EC-8CAF-1D1E5F******

Examples

Sample success responses

JSONformat

{
  "ClientIps": [
    "106.11.xx.xx"
  ],
  "ResourceGroups": [
    "user_default"
  ],
  "UserNames": [
    "test_user"
  ],
  "Databases": [
    "tpch_1g"
  ],
  "RequestId": "E0B56BCD-1BED-30EC-8CAF-1D1E5F******"
}

Error codes

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

Change history

Change time	Summary of changes	Operation
2024-08-30	The internal configuration of the API is changed, but the call is not affected	View Change Details