Query dimensions for SQL diagnostics using DescribeDiagnosisDimensions - AnalyticDB - Alibaba Cloud - AnalyticDB

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

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 IDs of all AnalyticDB for MySQL Data Warehouse Edition (V3.0) clusters within a region.	am-bt6u59zcmd945****
StartTime	string	Yes	The start of the time range to query. Set this parameter to a UNIX timestamp in milliseconds. Note Only data from the last 14 days can be queried. Querying older data returns an empty string.	1625220210000
EndTime	string	Yes	The end of the time range to query. Set this parameter to a UNIX timestamp in milliseconds. 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 list of regions.	cn-hangzhou
QueryCondition	string	Yes	The query condition for SQL statements, specified in JSON format. Use a combination of the `Type` and `Value` fields, or a combination of the Type, `Min`, and `Max` fields. Valid values for `Type`: `maxCost`, `status`, and `cost`. Valid values: `{"Type":"maxCost","Value":"100"}`: queries the top 100 most time-consuming SQL statements. The value of `Value` must be 100. `{"Type":"status","Value":"finished"}`: queries executed SQL statements, including both successful and failed statements. Set `Value` to `running` to query statements currently being executed, or to `failed` to query statements that failed. `{"Type":"cost","Min":"10","Max":"200"}`: queries SQL statements whose execution duration ranges from 10 to 200 milliseconds. You can specify custom values for Min and Max.	{"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	The response parameters.
ClientIps	array	The source IP addresses.
	string	The source IP address.	106.11.xx.xx
ResourceGroups	array	The resource groups.
	string	The name of the resource group.	user_default
UserNames	array	The usernames.
	string	The username.	test_user
Databases	array	The databases.
	string	The name of the database.	tpch_1g
RequestId	string	The request ID.	E0B56BCD-1BED-30EC-8CAF-1D1E5F******

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.